NAME

OntapClusterAPI - Contains the definitions and description of API Bindings for clustered Data ONTAP

SYNOPSIS

         my $s = NaServer->new($server, 1, 0); # create NaServer (server context)
         $s->set_admin_user('admin', 'password'); # provide username and password
         eval{ 
                 my $output = $s->system_get_version(); # use binding for system-get-version API
                 print "Data ONTAP version: $output->{version}\n"; # extract the required parameter from output
                 print "Clustered: $output->{is-clustered}\n"; 
                 my $tuple = $output->{'version-tuple'}->{'system-version-tuple'}; 
                 print "Generation: $tuple->{generation}  Major: $tuple->{major}  Minor: $tuple->{minor} \n";
                 $output = $s->quota_status_iter('query' => { 'quota-status-attributes' => {'volume' => 'vol0'}} ); # nested parameters as hashes of hashes
                 print "Quota Status: $output->{'attributes-list'}->{'quota-status-attributes'}->{'status'} \n";
         };
         if($@) { # check for any exception
                 my ($error_reason, $error_code) = $@ =~ /(.+)\s\((\d+)\)/;  # parse out error reason and error code
                 print "Error Reason: $error_reason  Code: $error_code\n"
         }

DESCRIPTION

NetApp Manageability SDK 9.6 provides support for Perl API bindings for both Data ONTAP APIs and Active IQ Unified Manager (formerly OnCommand Unified Manager) APIs. The Perl API bindings libraries contain interfaces to establish a connection with either the Data ONTAP server or the Active IQ Unified Manager (formerly OnCommand Unified Manager) server. By using these libraries, you can create Perl applications to access and manage the Data ONTAP server or Active IQ Unified Manager (formerly OnCommand Unified Manager) server.

NetApp Manageability SDK 9.6 Perl API bindings provide a runtime library NaServer.pm, which is available at <installation_folder>/lib/perl/NetApp. This library file enables you to establish a server connection, send requests and receive responses, and interpret error messages. Each binding can be called as a subroutine of NaServer module which in turn invokes the corresponding Data ONTAP or Active IQ Unified Manager (formerly OnCommand Unified Manager) API.

API BINDINGS

active_directory_account_create

[Family: vserver]

Create an Active Directory account for the given Vserver. If a CIFS server already exists for the requested Vserver, then this command will fail. The existing CIFS server should be deleted before retrying again. If joining a domain, this command may take several minutes to complete.

Inputs

Outputs

active_directory_account_delete

[Family: vserver]

Delete the Active Directory account. If a CIFS server already exists for the requested Vserver, cifs-server-delete API should be used to delete the machine account.

Inputs

Outputs

active_directory_account_get_iter

[Family: cluster, vserver]

Retrieve the list of active directory accounts

Inputs

Outputs

active_directory_account_modify

[Family: vserver]

Modify the Windows Active Directory domain. If a CIFS server already exists for the requested Vserver, cifs-server-modify API should be used to modify the Windows Active Directory domain. If re-joining the current domain or joining a new one, this command may take several minutes to complete.

Inputs

Outputs

active_directory_account_password_change

[Family: vserver]

Generate a new password for the machine account and change it in the Windows Active Directory domain.

Inputs

Outputs

active_directory_account_password_reset

[Family: vserver]

Reset the machine account password in the Windows Active Directory domain. This may be required if the password stored along with the machine account in the Windows Active Directory domain is changed or reset without the Vserver's knowledge. This operation requires the credentials for a user with permission to reset the password in the organizational unit (OU) that the machine account is a member of.

Inputs

Outputs

aggr_add

[Family: cluster]

Add disks to the specified aggregate. The disks to add are specified in the same way as for "aggr-create". Disks cannot be added to a mirrored aggregate if one or more of the plexes is offline. By the time the API returns, the disk(s) may not yet be completely added. Use 'aggr-list-info' to query the aggregate status to determine when it has finished growing due to the added disk(s). Same can be done using 'aggr-get-iter' when requested from Admin Vserver LIF. When the upgrade-64bit-mode input is provided to this API, the API produces a set of results in the background. These results are not available as output from aggr-add. Use the 'aggr-list-info' and 'volume-list-info' APIs to query the results of the 64-bit upgrade process on the aggregate and flexible volumes, respectively.

Inputs

Outputs

aggr_autobalance_aggregate_state_get_iter

[Family: cluster]

Iterate over a list of aggr-autobalance objects.

Inputs

Outputs

aggr_autobalance_config_get

[Family: cluster]

Displays the configuration for Auto Balance Aggregate.

Inputs

Outputs

aggr_autobalance_config_modify

[Family: cluster]

Modifies Auto Balance Aggregate configuration.

Inputs

Outputs

aggr_autobalance_notification_get_iter

[Family: cluster]

Displays the nodes that notify Auto Balance Aggregate about aggregates that need to be balanced

Inputs

Outputs

aggr_autobalance_volume_state_get_iter

[Family: cluster]

Iterate over a list of aggr-autobalance objects.

Inputs

Outputs

aggr_check_spare_low

[Family: cluster]

Return true if there is no suitable spare disk available for any filesystem (parity or data) disk.

Inputs

Outputs

aggr_create

[Family: cluster]

Create a new aggregate with the given name. The maximum number of aggregates that can be created on a filer varies by the type of configuration. In a standalone configuration, up to 200 aggregates can be created on a filer. In an HA configuration, this number drops to 100 and to 50 in a C-mode MetroCluster configuration. The aggregate may not yet be operational immediately after the API returns. Use 'aggr-list-info' to query the status of the newly-created aggregate to determine when it is fully operational. Same can be done using 'aggr-get-iter' when requested from Admin Vserver LIF. NOTE: If ECANT_USE_ALL_DISKS is returned, then the requested aggregate was indeed created, just not with all the disks that were specified.

Inputs

Outputs

aggr_destroy

[Family: cluster]

Destroys the specified aggregate or plex. If an aggregate is specified, all plexes in the aggregate are destroyed. If a plex is specified, only that plex is destroyed, leaving an unmirrored aggregate containing the remaining plex. The disks in the destroyed object become spare disks. Only offline aggregates and plexes can be destroyed. Note: Offline aggregates will be destroyed even if they contain one or more flexible volumes, which should not typically be the case. From cluster interface only aggregates are supported and plexes are not supported.

Inputs

Outputs

aggr_efficiency_cumulated_get

[Family: cluster]

Display the cumulated efficiency ratio for the specified aggregates

Inputs

Outputs

aggr_efficiency_get_iter

[Family: cluster]

Display the all Flash optimized aggregates and their storage efficiency.

Inputs

Outputs

aggr_get_filer_info

[Family: cluster]

Get information on what possibilities and parameters exist for aggregates on a given filer.

Inputs

Outputs

aggr_get_iter

[Family: cluster]

Iterate over a list of aggregate objects.

Inputs

Outputs

aggr_mirror

[Family: cluster]

Turns an unmirrored aggregate into a mirrored aggregate by adding a plex to it. The plex is either newly formed from disks chosen from a spare pool or, if the "victim-aggregate" option is specified, taken from another existing unmirrored aggregate. The named aggregate must currently be unmirrored. Disks may be specified explicitly using the "mirror-disks" list option in the same way as with the "aggr-create" and "aggr-add" commands. The number of disks indicated must match the number present in the existing aggregate. If disks are not specified explicitly, then disks are automatically selected to match those in the aggregate's existing plex.

Inputs

Outputs

aggr_modify_raid_type

[Family: cluster]

Modify the RAID type for the given aggregate to the specified "raid-type". This API can also selectively change the RAID type of specific raid groups in the aggregate based on the specified "disk-type". The change remains effective even if the filer is rebooted. This API does not support modifying options of a striped aggregate.

Inputs

Outputs

aggr_object_store_attach

[Family: cluster]

Attach an object store to an aggregate

Inputs

Outputs

aggr_object_store_config_create

[Family: cluster]

Create an object store configuration.

Inputs

Outputs

aggr_object_store_config_delete

[Family: cluster]

Delete an object store configuration

Inputs

Outputs

aggr_object_store_config_get

[Family: cluster]

Get the attributes of an object store configuration.

Inputs

Outputs

aggr_object_store_config_get_iter

[Family: cluster]

Iterate over a list of object store configurations.

Inputs

Outputs

aggr_object_store_config_modify

[Family: cluster]

Modify an existing object store configuration.

Inputs

Outputs

aggr_object_store_config_provider_list

[Family: cluster]

Returns a list of supported object store providers.

Inputs

Outputs

aggr_object_store_get_iter

[Family: cluster]

Display a list of aggregates which object stores are attached to.

Inputs

Outputs

aggr_object_store_vol_btuuids_get_iter

[Family: cluster]

Display a list of volume buftree UUIDs in a FabricPool aggregate.

Inputs

Outputs

aggr_offline

[Family: cluster]

Take the specified aggregate or plex offline. The operation takes effect before the API returns. Except in maintenance mode, the current root aggregate may not be taken offline. An aggregate marked to become the root aggregate cannot be taken offline. An aggregate containing one or more flexible volumes cannot be taken offline; its contained volumes must first be destroyed. A number of operations being performed on the given aggregate can prevent this operation from succeeding, either at all or for various lengths of time. If such operations are found, the system waits up to one second for them to finish. If they don't, the command is aborted. A check is also made for files in the aggregate opened by internal Data ONTAP processes. The command is aborted if any are found.

Inputs

Outputs

aggr_online

[Family: cluster]

Bring the specified aggregate or plex online. This command takes effect immediately. All volumes on the aggregate are brought to whatever state they were in before the aggregate was restricted or taken offline. If there are CIFS shares associated with the any of the aggregate's volumes that were also onlined, they are enabled.

Inputs

Outputs

aggr_options_list_info

[Family: cluster]

Get the options that have been set for the specified aggregate. This API does not support listing options of striped aggregate.

Inputs

Outputs

aggr_relocation

[Family: cluster]

Aggregate Relocation

Inputs

Outputs

aggr_relocation_status

[Family: cluster]

Iterate over the list of aggregate relocation status

Inputs

Outputs

aggr_rename

[Family: cluster]

Rename the specified aggregate.

Inputs

Outputs

aggr_restrict

[Family: cluster]

Restrict the specified aggregate. An aggregate with one or more flexible volumes cannot be restricted; all of its contained volumes must first be destroyed.

Inputs

Outputs

aggr_resync_options_get

[Family: cluster]

Get aggregate resynchronization options for a node in the cluster

Inputs

Outputs

aggr_resync_options_get_iter

[Family: cluster]

Get aggregate resynchronization options for each node in the cluster

Inputs

Outputs

aggr_resync_options_set

[Family: cluster]

Modify aggregate resynchronization options for a node in the cluster

Inputs

Outputs

aggr_scrub_list_info

[Family: cluster]

Get the status of parity scrubbing on the named aggregate. Status includes percentage complete and the scrub's suspended status (if appropriate). If an aggregate or node is not given, then status is generated for all RAID groups.

Inputs

Outputs

aggr_scrub_resume

[Family: cluster]

Resume parity scrubbing on the named aggregate, plex, or RAID group. If an aggregate or node is not given, then resume parity scrubbing on all RAID groups for which it has been suspended. Use "aggr-scrub-list-info" to check scrubbing status.

Inputs

Outputs

aggr_scrub_start

[Family: cluster]

Start parity scrubbing on the named aggregate, plex, or RAID group. Parity scrubbing compares the data disks to the parity disk in a RAID group, correcting the parity disk's contents as necessary. If an aggregate or node is not given, then parity scrubbing is started on all online aggregates. If an aggregate name is given, scrubbing is started on all RAID groups in the aggregate. If a plex name is given, scrubbing is started on all RAID groups contained in the plex. If a RAID group name is given, scrubbing is started only on that group. Use "aggr-scrub-list-info" to check scrubbing status. If a node is given, scrubbing is started on all raid groups on that node.

Inputs

Outputs

aggr_scrub_stop

[Family: cluster]

Stop parity scrubbing on the named aggregate, plex, or RAID group. If an aggregate or node is not given, scrubbing will stop on all RAID groups currently being scrubbed. Use "aggr-scrub-list-info" to check scrubbing status.

Inputs

Outputs

aggr_scrub_suspend

[Family: cluster]

Suspend parity scrubbing on the named aggregate, plex, RAID group, or node. If an aggregate or node is not given, suspend scrubbing on all RAID groups currently being scrubbed. Use "aggr-scrub-list-info" to check scrubbing status.

Inputs

Outputs

aggr_set_option

[Family: cluster]

Set the specified option for the given aggregate to "option-value". The change remains effective even if the filer is rebooted. Some options have values that are numbers, and some have values that are "on" (also expressible as "yes", "true", or "1" ) or "off" (also expressible as "no", "false", or "0"). A mixture of uppercase and lowercase characters may be used when typing an option's value. Note that the "root" option is special in that it doesn't have a corresponding value. This API does not support modifying options of striped aggregate.

Inputs

Outputs

aggr_space_get_iter

[Family: cluster]

Display a list of aggregates and a breakup of their used space. This information is only available when the aggregate is online. Some fields are expensive to compute, and if the system is under load, the information may not be returned. Best practice would be to only request the fields needed.

Inputs

Outputs

aggr_spare_get_iter

[Family: cluster]

Iterate over a list of spare disks

Inputs

Outputs

aggr_status_get_iter

[Family: cluster]

Aggregate enumeration ZAPI. Get status and topology information about one or more aggregates from RAID subsystem.

Inputs

Outputs

aggr_verify_list_info

[Family: cluster]

Get the status of RAID mirror verification on the named aggregate. Status includes percentage complete and whether it's currently suspended.

Inputs

Outputs

aggr_verify_resume

[Family: cluster]

Resume RAID mirror verification on the named aggregate. If no name is given, then resume mirror verification on all aggregates that have been suspended.

Inputs

Outputs

aggr_verify_start

[Family: cluster]

Start RAID mirror verification on the named aggregate. Verification compares the data in both plexes of a mirrored aggregate. In the default case, any blocks that differ are logged and no changes are made. The fix-plex option is used to fix any mismatches. It specifies which plex to fix. If no name is given, then mirror verification is started on all online aggregates. Use the "aggr-verify-list-info" API to check mirror verification status. If the fix-plex option is used, then a name must be specified.

Inputs

Outputs

aggr_verify_stop

[Family: cluster]

Stop RAID mirror verification on the named aggregate. If no name is given, stop mirror verification on all aggregates currently being verified.

Inputs

Outputs

aggr_verify_suspend

[Family: cluster]

Suspend RAID mirror verification on the named aggregate. If no name is given, suspend mirror verification on all aggregates currently being verified.

Inputs

Outputs

av_get_engine_info

[Family: cluster]

This gets the attributes of the Anti-Virus engine installed.

Inputs

Outputs

av_get_engine_options

[Family: cluster]

Get the attributes of the antivirus.

Inputs

Outputs

av_get_log

[Family: cluster]

Get the attributes of the antivirus.

Inputs

Outputs

av_get_remedy_info

[Family: cluster]

This gets the remedy information of the Anti-Virus engine installed. i.e. what to do when a virus is found.

Inputs

Outputs

av_get_version_info

[Family: cluster]

This gets the version information of the Anti-Virus engine installed.

Inputs

Outputs

av_log_iter

[Family: cluster]

Iterate over a list of antivirus objects.

Inputs

Outputs

av_set_engine_info

[Family: cluster]

This sets the attributes of the Anti-Virus engine installed. If an optional attribute is not specified, the current value is left unchanged.

Inputs

Outputs

av_set_engine_options

[Family: cluster]

Modify the attributes of antivirus object.

Inputs

Outputs

av_set_log

[Family: cluster]

Create a new antivirus.

Inputs

Outputs

av_set_remedy_info

[Family: cluster]

This sets the quarantine information of the Anti-Virus engine installed. If an optional attribute is not specified, the current value is left unchanged.

Inputs

Outputs

av_set_version_info

[Family: cluster]

This sets the version information of the Anti-Virus engine installed. If an optional attribute is not specified, the current value is left unchanged.

Inputs

Outputs

av_start_update

[Family: cluster]

Run an Anti-Virus Update job immediately

Inputs

Outputs

audit_get

[Family: cluster]

Get the cluster administrative audit settings

Inputs

Outputs

audit_log_config_get

[Family: cluster]

Get the cluster administrative audit settings

Inputs

Outputs

audit_log_config_modify

[Family: cluster]

Modify the cluster administrative audit settings

Inputs

Outputs

audit_log_get

[Family: cluster]

Get the cluster administrative audit settings

Inputs

Outputs

audit_log_get_iter

[Family: cluster]

Iterate of audit log entries

Inputs

Outputs

audit_modify

[Family: cluster]

Modify the cluster administrative audit settings

Inputs

Outputs

autosupport_budget_get

[Family: cluster]

Get AutoSupport time and size limits for the given node and subsystem.

Inputs

Outputs

autosupport_budget_get_iter

[Family: cluster]

Get AutoSupport time and size limits per subsystem for all nodes.

Inputs

Outputs

autosupport_budget_get_total_records

[Family: cluster]

Return the total number of records.

Inputs

Outputs

autosupport_budget_modify

[Family: cluster]

Modify AutoSupport time and size limits per subsystem.

Inputs

Outputs

autosupport_check_connectivity

[Family: cluster]

Test connectivity to the AutoSupport destinations for the given node.

Inputs

Outputs

autosupport_check_connectivity_iter

[Family: cluster]

Test connectivity to the Autosupport destinations for all nodes.

Inputs

Outputs

autosupport_check_iter

[Family: cluster]

Get Current Status of AutoSupport Subsystem for all nodes.

Inputs

Outputs

autosupport_compliant_get

[Family: cluster]

Get AutoSupport compliance hash mapping

Inputs

Outputs

autosupport_compliant_get_iter

[Family: cluster]

Get AutoSupport compliance hash mapping

Inputs

Outputs

autosupport_compliant_get_total_records

[Family: cluster]

Return the total number of records.

Inputs

Outputs

autosupport_config_get

[Family: cluster]

Get AutoSupport configuration settings for the given node.

Inputs

Outputs

autosupport_config_get_iter

[Family: cluster]

Get AutoSupport configuration settings for all nodes.

Inputs

Outputs

autosupport_config_get_total_records

[Family: cluster]

Return the total number of records.

Inputs

Outputs

autosupport_config_modify

[Family: cluster]

Modify AutoSupport configuration settings for the given node.

Inputs

Outputs

autosupport_destinations_get

[Family: cluster]

Get the list of AutoSupport destinations for the given node.

Inputs

Outputs

autosupport_destinations_get_iter

[Family: cluster]

Get the list of AutoSupport destinations for all nodes.

Inputs

Outputs

autosupport_destinations_get_total_records

[Family: cluster]

Return the total number of records. This sould be equal to the number of nodes in the cluster.

Inputs

Outputs

autosupport_download_get

[Family: cluster]

Get a download record for the given AutoSupport.

Inputs

Outputs

autosupport_download_get_iter

[Family: cluster]

Get the download records.

Inputs

Outputs

autosupport_history_cancel

[Family: cluster]

Cancel an AutoSupport Transmission.

Inputs

Outputs

autosupport_history_get

[Family: cluster]

Get a history record for the given AutoSupport.

Inputs

Outputs

autosupport_history_get_iter

[Family: cluster]

Get the history records for the last 50 AutoSupport messages.

Inputs

Outputs

autosupport_history_get_total_records

[Family: cluster]

Return the total number of records.

Inputs

Outputs

autosupport_history_retransmit

[Family: cluster]

Selectively retransmit a previously collected AutoSupport message.

Inputs

Outputs

autosupport_invoke

[Family: cluster]

Generate a new AutoSupport message

Inputs

Outputs

autosupport_invoke_core_upload

[Family: cluster]

Generate and send an AutoSupport message with an existing core file.

Inputs

Outputs

autosupport_invoke_diagnostic

[Family: cluster]

Generate and send an AutoSupport message with diagnostic content from specified subsystems.

Inputs

Outputs

autosupport_invoke_diagnostic_iter

[Family: cluster]

Generate and send an AutoSupport message with diagnostic content from specified subsystems.

Inputs

Outputs

autosupport_invoke_iter

[Family: cluster]

Generate a new AutoSupport message

Inputs

Outputs

autosupport_invoke_performance_archive

[Family: cluster]

Generate and send an AutoSupport message with performance archives.

Inputs

Outputs

autosupport_invoke_performance_archive_iter

[Family: cluster]

Generate and send an AutoSupport message with performance archives.

Inputs

Outputs

autosupport_invoke_splog

[Family: cluster]

Generate a Remote Service Processor Log AutoSupport message

Inputs

Outputs

autosupport_manifest_get_iter

[Family: cluster]

Get a detailed manifest for the contents of an AutoSupport.

Inputs

Outputs

autosupport_manifest_get_total_records

[Family: cluster]

Return the total number of records.

Inputs

Outputs

autosupport_trigger_get

[Family: cluster]

Get the AutoSupport trigger data for the given node and EMS message.

Inputs

Outputs

autosupport_trigger_get_iter

[Family: cluster]

Get a list of the AutoSupport trigger data for all nodes.

Inputs

Outputs

autosupport_trigger_get_total_records

[Family: cluster]

Return the total number of records.

Inputs

Outputs

autosupport_trigger_modify

[Family: cluster]

Modify the AutoSupport trigger data for the given node and EMS message.

Inputs

Outputs

cf_aggregate_giveback_status

[Family: cluster]

Returns giveback status of all the aggregates in the cluster which are taken over or were given back.

Inputs

Outputs

cf_force_takeover

[Family: cluster]

Forces one filer to take over its partner even though the filer detects an error that would otherwise prevent a takeover. For example, normally, if a detached or faulty interconnect cable between the filers causes the filers' NVRAM contents to be unsynchronized, takeover is disabled. However, this will allow the filer to take over its partner despite the unsynchronized NVRAM contents. cf-force-takeover is dangerous and can lead to data corruption; in almost all cases, use cf-takeover instead.

Inputs

Outputs

cf_get_iter

[Family: cluster]

Iterate over a list of cf objects.

Inputs

Outputs

cf_get_partner

[Family: cluster]

Get the host name of the partner. If the name is unknown, It will return partner-unknown.

Inputs

Outputs

cf_giveback

[Family: cluster]

Initiates a giveback of partner resources. Once the giveback is complete, the automatic takeover capability is disabled until the partner is rebooted. A giveback fails if outstanding CIFS sessions, active system dump processes, or other filer operations makes a giveback dangerous or disruptive.

Inputs

Outputs

cf_hwassist_stats

[Family: cluster]

Get useful information about statistics of hardware assisted takeover functionality.

Inputs

Outputs

cf_hwassist_stats_clear

[Family: cluster]

Get useful information about stats of hw_assist functionality.

Inputs

Outputs

cf_hwassist_status

[Family: cluster]

Get useful information about the status of hw_assist functionality.

Inputs

Outputs

cf_hwassist_test

[Family: cluster]

Validates the hardware-assisted takeover configuration. functionality.

Inputs

Outputs

cf_mode_set

[Family: cluster]

Enable or disable the high-availability (HA) for this node. A reboot of the node is required for the HA mode to become effective.

Inputs

Outputs

cf_modify_iter

[Family: cluster]

Modify the attributes of cf or a group of cf objects.

Inputs

Outputs

cf_service_disable

[Family: cluster]

Disables the takeover capability of this filer in the cluster.

Inputs

Outputs

cf_service_enable

[Family: cluster]

Enables the takeover capability of this filer in the cluster. This spawns a process to enable the service

Inputs

Outputs

cf_status

[Family: cluster]

Get useful information about the status of the high availability service. If the monitor is not initialized, this returns an error.

Inputs

Outputs

cf_takeover

[Family: cluster]

Initiates a takeover of the storage partner. Takeover is done asynchronously; status may be monitored by calling the cf-status API and examining the state field. If automatic giveback is enabled then control will be returned to storage partner once it boots up.

Inputs

Outputs

cf_takeover_status

[Family: cluster]

Get the takeover status of a node and the takeover status of all its partner aggregates, for all nodes in a cluster.

Inputs

Outputs

cg_commit

[Family: vserver]

Commits the snapshots that were started during the preceeding cg-start call that returned the cg-id key, and unfences the volumes that were fenced. If cg-commit API times out, then it means that either too many volumes were specified to the cg-start api or the timeout value for the cg-start api was very small. In this situation, the caller should try to perform the cg-start operation by specifying lesser volumes or by specifying higher timeout value.

Inputs

Outputs

cg_start

[Family: vserver]

Starts the checkpoint cycle for externally synchronized checkpoints in the filer. This operation fences the specified volumes and returns "success" (if successful). If the API returns "success", the call starts a snapshot create operation in these volumes. If the API returns "success", this operation SHOULD be followed by a call to cg-commit (below).

This API is not supported on Infinite Volume.

Inputs

Outputs

cifs_branchcache_create

[Family: vserver]

Create and setup the BranchCache service.

Inputs

Outputs

cifs_branchcache_flush

[Family: vserver]

Flush (delete) all the BranchCache hashes that have been generated for a Vserver.

Inputs

Outputs

cifs_branchcache_get

[Family: vserver]

Retrieve information about the BranchCache service.

Inputs

Outputs

cifs_branchcache_get_iter

[Family: cluster, vserver]

Retrieve the per-Vserver BranchCache configurations for the cluster.

Inputs

Outputs

cifs_branchcache_hash

[Family: vserver]

Force the generation of BranchCache hashes for a file or path.

Inputs

Outputs

cifs_branchcache_modify

[Family: vserver]

Modify the CIFS BranchCache service settings

Inputs

Outputs

cifs_branchcache_remove

[Family: vserver]

Remove the BranchCache service

Inputs

Outputs

cifs_cache_settings_get

[Family: vserver]

Get the CIFS name and SID cache configuration of the SVM

Inputs

Outputs

cifs_cache_settings_modify

[Family: vserver]

Modify the CIFS name and SID cache configuration of the specified SVM. Omitted (optional) fields will not be changed.

Inputs

Outputs

cifs_character_mapping_create

[Family: vserver]

Create a character mapping. This API is not supported for FlexGroups or Vservers with Infinite Volume.

Inputs

Outputs

cifs_character_mapping_destroy

[Family: vserver]

Delete a character mapping. This API is not supported for FlexGroups or Vservers with Infinite Volume.

Inputs

Outputs

cifs_character_mapping_get_iter

[Family: cluster, vserver]

Display a character mapping

Inputs

Outputs

cifs_character_mapping_modify

[Family: vserver]

Modify a character mapping. This API is not supported for FlexGroups or Vservers with Infinite Volume.

Inputs

Outputs

cifs_check_server_get_iter

[Family: cluster, vserver]

Display the Status of Connectivity from Each Node to the CIFS Server for the Given Vserver

Inputs

Outputs

cifs_connection_get_iter

[Family: cluster, vserver]

Retrieve the list of the established CIFS connections.

Inputs

Outputs

cifs_domain_discovered_servers_get_iter

[Family: cluster, vserver]

Retrieve the list of servers discovered by the cluster.

Inputs

Outputs

cifs_domain_discovered_servers_reset

[Family: vserver]

Command to trigger re-discovery of servers.

Inputs

Outputs

cifs_domain_name_mapping_search_add

[Family: vserver]

Add to the list of trusted domains for name-mapping search

Inputs

Outputs

cifs_domain_name_mapping_search_get_iter

[Family: cluster, vserver]

Retrieve the list of trusted domains for name-mapping search.

Inputs

Outputs

cifs_domain_name_mapping_search_modify

[Family: vserver]

Modify the list of trusted domains for name-mapping search

Inputs

Outputs

cifs_domain_name_mapping_search_remove

[Family: vserver]

Remove from the list of trusted domains for name-mapping search

Inputs

Outputs

cifs_domain_password_schedule_get_iter

[Family: cluster, vserver]

Iterate over a list of cifs-domain-password-schedule objects.

Inputs

Outputs

cifs_domain_password_schedule_modify

[Family: vserver]

Modify the attributes of cifs-domain-password-schedule object.

Inputs

Outputs

cifs_domain_preferred_dc_add

[Family: vserver]

Add to a list of preferred domain controllers

Inputs

Outputs

cifs_domain_preferred_dc_get_iter

[Family: cluster, vserver]

Retrieve the list of preferred domain controllers associated with Active Directory domains.

Inputs

Outputs

cifs_domain_preferred_dc_remove

[Family: vserver]

Remove from a list of preferred domain controllers

Inputs

Outputs

cifs_domain_server_discovery_mode_get

[Family: vserver]

Get the CIFS server domain discovery mode of a Vserver

Inputs

Outputs

cifs_domain_server_discovery_mode_get_iter

[Family: cluster, vserver]

Iterate through the CIFS server domain discovery mode of the cluster

Inputs

Outputs

cifs_domain_server_discovery_mode_modify

[Family: vserver]

Modify the CIFS server domain discovery mode of a Vserver

Inputs

Outputs

cifs_domain_trusts_get_iter

[Family: cluster, vserver]

Retrieve the list of discovered trusted domains.

Inputs

Outputs

cifs_domain_trusts_rediscover

[Family: vserver]

Command to trigger re-discovery of trusted domains.

Inputs

Outputs

cifs_home_directory_get_iter

[Family: cluster, vserver]

Displays CIFS home directory configurations

Inputs

Outputs

cifs_home_directory_modify

[Family: vserver]

Modify CIFS home directory configurations

Inputs

Outputs

cifs_home_directory_search_path_add

[Family: vserver]

Add a path to the list of paths that will be searched to find a CIFS user's home directory.

Inputs

Outputs

cifs_home_directory_search_path_delete

[Family: vserver]

Delete a home directory search path. This API is deprecated in Data ONTAP 8.2 and later but retained for backwards compatibility. Use cifs-home-directory-search-path-remove instead of cifs-home-directory-search-path-delete.

Inputs

Outputs

cifs_home_directory_search_path_get_iter

[Family: cluster, vserver]

Iterate over a list of cifs-home-directory-search-path objects.

Inputs

Outputs

cifs_home_directory_search_path_remove

[Family: vserver]

Remove a home directory search path.

Inputs

Outputs

cifs_home_directory_search_path_reorder

[Family: vserver]

Change the position of this path in the list of paths that will be searched to find a CIFS user's home directory.

Inputs

Outputs

cifs_local_group_create

[Family: vserver]

Create a single local group

Inputs

Outputs

cifs_local_group_delete

[Family: vserver]

Delete a single local group

Inputs

Outputs

cifs_local_group_get_iter

[Family: cluster, vserver]

Retrieve the list of local groups

Inputs

Outputs

cifs_local_group_members_add_members

[Family: vserver]

Add local users or Active Directory users or groups to a local group

Inputs

Outputs

cifs_local_group_members_get_iter

[Family: cluster, vserver]

Retrieve the list of local group members

Inputs

Outputs

cifs_local_group_members_remove_members

[Family: vserver]

Remove local users or Active Directory users or groups from a local group

Inputs

Outputs

cifs_local_group_modify

[Family: vserver]

Modify a description of a single local group

Inputs

Outputs

cifs_local_group_rename

[Family: vserver]

Rename a local group

Inputs

Outputs

cifs_local_user_create

[Family: vserver]

Configure and create a local user, associated with a Vserver

Inputs

Outputs

cifs_local_user_delete

[Family: vserver]

Delete a single local user

Inputs

Outputs

cifs_local_user_get_iter

[Family: cluster, vserver]

Retrieve the list of local users

Inputs

Outputs

cifs_local_user_membership_get_iter

[Family: cluster, vserver]

Retrieve local users' membership information

Inputs

Outputs

cifs_local_user_modify

[Family: vserver]

Modify a single local user

Inputs

Outputs

cifs_local_user_rename

[Family: vserver]

Rename a local user

Inputs

Outputs

cifs_local_user_set_password

[Family: vserver]

Set password for a local user

Inputs

Outputs

cifs_nbtstat_get_iter

[Family: cluster, vserver]

Retrieve the NetBIOS Name Service statistics for Vservers in cluster.

Inputs

Outputs

cifs_options_get_iter

[Family: cluster, vserver]

Iterate over a list of cifs-options objects.

Inputs

Outputs

cifs_options_modify

[Family: vserver]

Modify the attributes of cifs-options object.

Inputs

Outputs

cifs_password_change

[Family: vserver]

Generate a new password for the CIFS server's machine account and change it in the Windows Active Directory domain.

Inputs

Outputs

cifs_password_reset

[Family: vserver]

Reset the CIFS server's machine account password in the Windows Active Directory domain. This may be required if the password stored along with the machine account in the Windows Active Directory domain is changed or reset without the Vserver's knowledge. This operation requires the credentials for a user with permission to reset the password in the organizational unit (OU) that the machine account is a member of.

Inputs

Outputs

cifs_preferred_dc_check_get_iter

[Family: cluster, vserver]

Display the Status of the Preferred-DCs configured for the Given Vserver

Inputs

Outputs

cifs_privilege_add_privilege

[Family: vserver]

Add privileges to a local or Active Directory user or group

Inputs

Outputs

cifs_privilege_get_iter

[Family: cluster, vserver]

Retrieve the list of local groups

Inputs

Outputs

cifs_privilege_remove_privilege

[Family: vserver]

Remove privileges from a local or Active Directory user or group

Inputs

Outputs

cifs_privilege_reset_privilege

[Family: vserver]

Reset privileges for a local or Active Directory user or group

Inputs

Outputs

cifs_security_get_iter

[Family: cluster, vserver]

Iterate over a list of cifs-security objects.

Inputs

Outputs

cifs_security_modify

[Family: vserver]

Modify the security configuration of a CIFS server.

Inputs

Outputs

cifs_server_add_netbios_aliases

[Family: vserver]

Add NetBIOS aliases for the CIFS server name

Inputs

Outputs

cifs_server_create

[Family: vserver]

Configure and setup CIFS services on a Vserver. If joining a domain, this command may take several minutes to complete.

Inputs

Outputs

cifs_server_delete

[Family: vserver]

Delete a CIFS server. If the admin-username and admin-password are not specified, the CIFS server's machine account will not be deleted from the Windows Active Directory domain. The deletion of the CIFS server will also delete the CIFS shares associated with it.

Inputs

Outputs

cifs_server_get_iter

[Family: cluster, vserver]

Retrieve the list of CIFS servers on the cluster and their basic configurations.

Inputs

Outputs

cifs_server_modify

[Family: vserver]

Modify the basic properties of a CIFS server. If re-joining the current domain or joining a new one, this command may take several minutes to complete.

Inputs

Outputs

cifs_server_remove_netbios_aliases

[Family: vserver]

Remove NetBIOS aliases

Inputs

Outputs

cifs_server_start

[Family: vserver]

Start a CIFS server on the specified Vserver. The CIFS server must already exist. To create a CIFS server, use cifs-server-create.

Inputs

Outputs

cifs_server_stop

[Family: vserver]

Stop a CIFS server on the specified Vserver. Note that established sessions will be terminated and their open files closed. Workstations with cached data will not be able to save those changes, which could result in data loss.

Inputs

Outputs

cifs_session_close

[Family: cluster, vserver]

Close an open CIFS session

Inputs

Outputs

cifs_session_file_close

[Family: cluster, vserver]

Close an open CIFS file.

Inputs

Outputs

cifs_session_file_get_iter

[Family: cluster, vserver]

Retrieve the list of the opened CIFS files.

Inputs

Outputs

cifs_session_get_iter

[Family: cluster, vserver]

Retrieve the list of the established CIFS sessions.

Inputs

Outputs

cifs_share_access_control_create

[Family: vserver]

Add permissions for a user or group for a defined CIFS share.

Inputs

Outputs

cifs_share_access_control_delete

[Family: vserver]

Remove permissions for a user or group on a defined CIFS share.

Inputs

Outputs

cifs_share_access_control_get_iter

[Family: cluster, vserver]

Retrieve the list of permissions on defined CIFS shares.

Inputs

Outputs

cifs_share_access_control_modify

[Family: vserver]

Modify the permissions for a user or group on a defined CIFS share.

Inputs

Outputs

cifs_share_create

[Family: vserver]

Creates a new CIFS share rooted at the specified path.

Inputs

Outputs

cifs_share_delete

[Family: vserver]

Deletes the specified CIFS share.

Inputs

Outputs

cifs_share_get_iter

[Family: cluster, vserver]

Gives information about one or more CIFS shares.

Inputs

Outputs

cifs_share_modify

[Family: vserver]

Modifies settings of a CIFS share, even if the shares are in use.

Inputs

Outputs

cifs_symlink_create

[Family: vserver]

Create a new CIFS symbolic link path mapping from a UNIX symlink to a target CIFS path. This symbolic link path mapping will be effective on symbolic links that have a prefix match with the value of 'unix-path'. e.g.: if the value of 'unix-path' is '/usr/local/' and there exists a symbolic link on the file system at '/home/user/link' which points to '/usr/local/share/dest'. If a CIFS client accesses the symbolic link 'link', this entry of path mapping would have a prefix match '/usr/local/'. The CIFS client would be redirected to the location pointed to by this path mapping's 'cifs-server', 'share-name' and 'cifs-path' fields.

Inputs

Outputs

cifs_symlink_delete

[Family: vserver]

Delete a CIFS symbolic link path mapping.

Inputs

Outputs

cifs_symlink_get_iter

[Family: cluster, vserver]

Retrieve the list of CIFS symbolic link path mappings.

Inputs

Outputs

cifs_symlink_modify

[Family: vserver]

Modify a CIFS symbolic link path mapping parameters.

Inputs

Outputs

cifs_user_home_directory_path_get

[Family: vserver]

Find the user's home directory based on user name

Inputs

Outputs

cifs_user_home_directory_path_get_iter

[Family: cluster, vserver]

Find the user's home directory based on user name

Inputs

Outputs

cifs_users_and_group_local_group_members_get_iter

[Family: cluster, vserver]

Retrieve the list of local group members

Inputs

Outputs

cifs_users_and_group_local_user_membership_get_iter

[Family: cluster, vserver]

Retrieve local users' membership information

Inputs

Outputs

volume_charmap_get

[Family: vserver]

Return charmap information for a specified volume.

Inputs

Outputs

volume_charmap_set

[Family: vserver]

Set the character mapping on a volume

Inputs

Outputs

clock_get_clock

[Family: cluster, vserver]

gets current date and time from filer.

Inputs

Outputs

clock_get_timezone

[Family: cluster, vserver]

Gets current timezone and timezone file version.

Inputs

Outputs

clone_autodelete

[Family: vserver]

Enable autodelete on a file, LUN, or NVMe namespace clone. This command is only supported for flexible volumes.

Inputs

Outputs

clone_autodelete_status

[Family: vserver]

Get the information about file or LUN clone autodeletion

Inputs

Outputs

clone_create

[Family: vserver]

Create a file/sub file, LUN/sub LUN, or NVMe namespace/sub NVMe namespace clone. This command is only supported for flexible volumes.

Inputs

Outputs

clone_deletion_add_extension

[Family: vserver]

Add new supported file extensions for file(s) and lun(s) on the specified volume to be deleted with clone-delete. This command is only supported for flexible volumes.

Inputs

Outputs

clone_deletion_get_iter

[Family: cluster, vserver]

List the clone deletion info

Inputs

Outputs

clone_deletion_minimum_size

[Family: vserver]

Required minimum size of the file(s) and lun(s) on the specified volume to be deleted with clone-delete.

Inputs

Outputs

clone_deletion_remove_extension

[Family: vserver]

Remove the no longer supported file extensions for file(s) and lun(s) on the specified volume to be deleted with clone-delete. This command is only supported for flexible volumes.

Inputs

Outputs

clone_split_enable

[Family: vserver]

Enable clone split on split disabled entry

Inputs

Outputs

clone_split_load_get_iter

[Family: cluster, vserver]

Gets information about load on all nodes due to file or LUN clone split operations.

Inputs

Outputs

clone_split_status

[Family: vserver]

Get the information about unsplit file or LUN clones in a volume

Inputs

Outputs

clone_token_create

[Family: cluster, vserver]

Create a token to reserve available split load on a node. This token can be used with clone-create api to use up the reserved split load. This will to allow clone creates from getting throttled.

Inputs

Outputs

clone_token_delete

[Family: cluster, vserver]

Delete token(s) to increase the allowed split load by a node.

Inputs

Outputs

clone_token_get

[Family: cluster, vserver]

Get the information about a specified token.

Inputs

Outputs

clone_token_get_iter

[Family: cluster, vserver]

Get the information about all reserved tokens.

Inputs

Outputs

clone_token_modify_expiry_limit

[Family: cluster, vserver]

Modify the allowed expiry limit for token(s).

Inputs

Outputs

cluster_add_node

[Family: cluster]

Use this API to add new nodes to cluster. Provide only one of node-count, node-ip, or cluster-ips. To watch the progress use cluster-add-node-status-get-iter API. A job will be spawned to operate on the cluster and the job id will be returned. The progress of the job can be tracked using the job APIs.

Inputs

Outputs

cluster_add_node_status_get_iter

[Family: cluster]

Get Progress of Cluster Create or Node Add Operation

Inputs

Outputs

cluster_contact_get

[Family: cluster]

Returns the contact information.

Inputs

Outputs

cluster_contact_modify

[Family: cluster]

Modifies the contact information.

Inputs

Outputs

cluster_create

[Family: cluster]

Start the process to create a cluster using this node. Use cluster-add-node-status-get-iter to track the status of the operation. A job will be spawned to operate on the cluster and the job id will be returned. The progress of the job can be tracked using the job APIs.

Inputs

Outputs

cluster_create_join_progress_get

[Family: cluster]

Once the cluster create or cluster join operation has been started on this node, use this ZAPI to get the current status of the operation. During cluster join, there is a 1 to 5 second window where the network connection will be unavailable while web services restart. The caller will have to periodically retry until this ZAPI becomes available.

Inputs

Outputs

cluster_identity_get

[Family: cluster]

Returns the cluster identity information.

Inputs

Outputs

cluster_identity_modify

[Family: cluster]

Modifies the cluster identity information.

Inputs

Outputs

cluster_join

[Family: cluster]

Start the process of joining this node to a cluster. Join can be done by Cluster IP Address. Only one join operation is supported at a time. Use cluster-create-join-progress-get to track the status of the operation. This API is deprecated as of Data ONTAP 9.2, and the cluster-add-node API should be used instead.

Inputs

Outputs

cluster_log_forward_create

[Family: cluster]

Create a log forwarding configuration

Inputs

Outputs

cluster_log_forward_destroy

[Family: cluster]

Delete a log forwarding configuration

Inputs

Outputs

cluster_log_forward_get

[Family: cluster]

Get information about log forwarding

Inputs

Outputs

cluster_log_forward_get_iter

[Family: cluster]

Get information about log forwarding

Inputs

Outputs

cluster_log_forward_modify

[Family: cluster]

Modify the log forwarding configuration

Inputs

Outputs

cluster_log_forward_statistics_get

[Family: cluster]

Get information about log forwarding statistics

Inputs

Outputs

cluster_log_forward_statistics_get_iter

[Family: cluster]

Get information about log forwarding statistics

Inputs

Outputs

cluster_node_get

[Family: cluster]

Returns information about a node in a cluster.

Inputs

Outputs

cluster_node_get_iter

[Family: cluster]

Returns information about nodes in a cluster.

Inputs

Outputs

cluster_node_modify

[Family: cluster]

Modifies state of a node in a cluster.

Inputs

Outputs

cluster_remove_node

[Family: cluster]

Removes a node from the cluster. A job will be spawned to operate on the cluster and the job id will be returned. The progress of the job can be tracked using the job APIs.

Inputs

Outputs

cluster_zoneinfo_get

[Family: cluster]

Get zoneinfo information

Inputs

Outputs

cluster_zoneinfo_load_from_uri

[Family: cluster]

This commands loads a new set of timezone zoneinfo data to replace the version installed in the cluster.

Releases of Data ONTAP software contain the timezone data that is current at the time of release. If a change is made to the timezone between Data ONTAP releases, then an update can be made to the installed data.

For instance, if a change is made to when daylight saving time is observed for a country then an update to cluster zoneinfo data may be required.

Only zoneinfo files provided for use in Data ONTAP should be used with this command.

To update the zoneinfo database do the following: The command need only be executed once for the cluster. The data will be distributed to each node of the cluster.

Inputs

Outputs

cluster_image_get

[Family: cluster]

Get the attributes of the cluster-image.

Inputs

Outputs

cluster_image_get_download_progress

[Family: cluster]

Check the progress of current image download started by the cluster-image-package-download ZAPI.

Inputs

Outputs

cluster_image_get_iter

[Family: cluster]

Iterate over a list of cluster-image objects.

Inputs

Outputs

cluster_image_get_upgrade_plan

[Family: cluster]

The cluster-image-get-upgrade-plan API generates an Upgrade Plan and Backout Plan for the specified target image. The target package-version must be provided.

Inputs

Outputs

cluster_image_metrocluster_update_progress_info_get

[Family: cluster]

Get information on cluster image update progress for MetroCluster

Inputs

Outputs

cluster_image_node_update_progress_info

[Family: cluster]

Get information on a node's image update progress

Inputs

Outputs

cluster_image_package_delete

[Family: cluster]

The cluster-image-package-delete API removes the given package from the cluster image package repository.

Inputs

Outputs

cluster_image_package_download

[Family: cluster]

The cluster-image-package-download API downloads the specified package. This API is asynchronous and returns immediately after the download is started. The download progress can be monitored by calling cluster-image-get-download-progress ZAPI. The package-url string must be provided.

Inputs

Outputs

cluster_image_package_download_abort

[Family: cluster]

Abort an ongoing package download operation.

Inputs

Outputs

cluster_image_package_local_get

[Family: cluster]

The cluster-image-package-local-get API retrieves detailed information about a package located in the cluster image package repository.

Inputs

Outputs

cluster_image_package_local_get_iter

[Family: cluster]

Get multiple locally available package records

Inputs

Outputs

cluster_image_update

[Family: cluster]

The cluster-image update API validates, installs prerequisite component updates, and installs Data ONTAP to all specified nodes within a cluster in a nondisruptive manner. Since validation, which is run as part of update, requires a minimum of 30 seconds, the API should be called with sufficient timeout value.

Inputs

Outputs

cluster_image_update_cancel

[Family: cluster]

The cluster-image-update-cancel API cancels a package update that is currently in progress. The update will stop and be canceled at the end of the current logical operation. Logical operations are: - After the cluster validation, or prerequisite update phase - After the update of each HA pair - Immediately, if the update is currently paused After the successful completion of this command the update will be removed from the package update queue. The cancellation will be logged in the update history.

Inputs

Outputs

cluster_image_update_history_get_iter

[Family: cluster]

Get multiple update history records.

Inputs

Outputs

cluster_image_update_log_get_iter

[Family: cluster]

Get multiple update logs

Inputs

Outputs

cluster_image_update_pause

[Family: cluster]

The cluster-image-update-pause API pauses an update that is in progress. The update will pause at the end of the current logical operation. Logical operations include: - After the cluster validation, or prerequisite update phase - After the update of each node After the successful completion of this command the currently running update will be paused at the end of the current logical operation.

Inputs

Outputs

cluster_image_update_progress_get_iter

[Family: cluster]

This API provides the status of all phases of update that is in progress.

Inputs

Outputs

cluster_image_update_progress_info

[Family: cluster]

Get information on cluster image update progress

Inputs

Outputs

cluster_image_update_resume

[Family: cluster]

The cluster-image-update-resume API resumes a package update that is currently paused. If the update is not in the paused state the API call will fail. After the successful completion of this command the current paused update will resume from the last successful operation completed.

Inputs

Outputs

cluster_image_validate

[Family: cluster]

The cluster-image-validate API validates the various logical and physical components of a cluster to ensure that a nondisruptive update can occur. Since validation requires a minimum of 30 seconds, the API should be called with sufficient timeout value.

Inputs

Outputs

cluster_peer_authn_offer_cancel

[Family: cluster]

Cancel the outstanding offer to authenticate with a peer cluster

Inputs

Outputs

cluster_peer_authn_offer_get

[Family: cluster]

Return the specified peer cluster relationship authentication offer information

Inputs

Outputs

cluster_peer_authn_offer_get_iter

[Family: cluster]

Returns a list of cluster peer relationship authentication offers

Inputs

Outputs

cluster_peer_authn_offer_modify

[Family: cluster]

Modifies the cluster peer relationship authentication offer, as created by the cluster-peer-create or cluster-peer-modify APIs.

Inputs

Outputs

cluster_peer_connection_destroy

[Family: cluster]

Terminate a current peering connection

Inputs

Outputs

cluster_peer_connections_get

[Family: cluster]

Return information about the specified connection to the specified cluster peer

Inputs

Outputs

cluster_peer_connections_get_iter

[Family: cluster]

Returns a list of connections to cluster peers

Inputs

Outputs

cluster_peer_create

[Family: cluster]

Create a cluster peer relationship and, optionally, an offer to authenticate with a peer. Initiate an authenticated relationship, and an offer to authenticate with a peer, by including the passphrase parameter. Initiate an unauthenticated relationship by omitting the passphrase and, optionally, including a user-name and password.

Inputs

Outputs

cluster_peer_delete

[Family: cluster]

Delete a cluster peer relationship as well as any an offer to authenticate with the peer cluster.

Inputs

Outputs

cluster_peer_get

[Family: cluster]

Return the specified peer cluster relationship information

Inputs

Outputs

cluster_peer_get_iter

[Family: cluster]

Returns a list of cluster peer relationships

Inputs

Outputs

cluster_peer_health_info_get

[Family: cluster]

Get the health of the specified peer node

Inputs

Outputs

cluster_peer_health_info_get_iter

[Family: cluster]

Get the health of all local and peer nodes sequentially

Inputs

Outputs

cluster_peer_modify

[Family: cluster]

Modifies a cluster peer relationship, optionally also creating an offer to authenticate with a peer.

Inputs

Outputs

cluster_peer_modify_local_name

[Family: cluster]

Modify the local name for a cluster peer.

Inputs

Outputs

cluster_peer_ping_iter

[Family: cluster]

Ping the specified peer nodes. Ping operations take place between a node in a cluster and a node in a remote cluster. The originating node is the node which initiates the ping operation and the destination cluster and node specify the remote node which is the target of the ping.

Inputs

Outputs

cluster_peer_policy_get

[Family: cluster]

Return the cluster peering policy configuration.

Inputs

Outputs

cluster_peer_policy_modify

[Family: cluster]

Modify the cluster peering policy configuration.

Inputs

Outputs

cluster_switch_configure_health_monitor

[Family: cluster]

Cluster-switch health-monitor no-ontap-dependency(NOD) configuration setup

Inputs

Outputs

cluster_switch_create

[Family: cluster]

Add information about a cluster switch or management switch.

Inputs

Outputs

cluster_switch_delete

[Family: cluster]

Delete information about a cluster switch or management switch.

Inputs

Outputs

cluster_switch_get_iter

[Family: cluster]

(cluster-swt-get-iter is now deprecated. Use cluster-switch-get-iter instead.)Display the configuration for cluster and management switches.

Inputs

Outputs

cluster_switch_modify

[Family: cluster]

Modify information about a switch's configuration.

Inputs

Outputs

cluster_switch_poll_get

[Family: cluster]

Returns cluster switch polling interval information.

Inputs

Outputs

cluster_switch_poll_modify

[Family: cluster]

Modify cluster switch polling interval information.

Inputs

Outputs

cluster_swt_get_iter

[Family: cluster]

Iterate over a list of Cluster Switch Information objects.

Inputs

Outputs

config_backup_copy

[Family: cluster]

Copy a configuration backup. A job will be queued to copy the configuration backup. A job will be spawned to operate on the config-backup and the job id will be returned. The progress of the job can be tracked using the job APIs.

Inputs

Outputs

config_backup_create

[Family: cluster]

Create a configuration backup. A job will be queued to create the configuration backup in the background. Creation of configuration backup may take several minutes. This ZAPI creates an on demand backup. A job will be spawned to operate on the config-backup and the job id will be returned. The progress of the job can be tracked using the job APIs.

Inputs

Outputs

config_backup_delete

[Family: cluster]

Delete a configuration backup.

Inputs

Outputs

config_backup_download

[Family: cluster]

Download a configuration backup from a URL.

Inputs

Outputs

config_backup_info_get

[Family: cluster]

Return information about a specified configuration backup.

Inputs

Outputs

config_backup_info_get_iter

[Family: cluster]

Return a list of configuration backups in the cluster.

Inputs

Outputs

config_backup_rename

[Family: cluster]

Rename a configuration backup. Renamed backup stays on the same node.

Inputs

Outputs

config_backup_settings_get

[Family: cluster]

Return information about the configuration backup settings.

Inputs

Outputs

config_backup_settings_modify

[Family: cluster]

Modify the settings for configuration backup operations.

Inputs

Outputs

config_backup_settings_password_set

[Family: cluster]

Modify the password for destination URL.

Inputs

Outputs

config_backup_upload

[Family: cluster]

Upload a configuration backup to a URL.

Inputs

Outputs

coredump_trigger

[Family: cluster]

Trigger a coredump via the Service Processor

Inputs

Outputs

dashboard_alarm_get

[Family: cluster]

This command is removed starting from ONTAP 9.0.

Inputs

Outputs

dashboard_alarm_get_iter

[Family: cluster]

This command is removed starting from ONTAP 9.0.

Inputs

Outputs

dashboard_alarm_get_total_records

[Family: cluster]

This command is removed starting from ONTAP 9.0.

Inputs

Outputs

dashboard_alarm_threshold_get

[Family: cluster]

This command is removed starting from ONTAP 9.0.

Inputs

Outputs

dashboard_alarm_threshold_get_iter

[Family: cluster]

This command is removed starting from ONTAP 9.0.

Inputs

Outputs

dashboard_alarm_threshold_get_total_records

[Family: cluster]

This command is removed starting from ONTAP 9.0.

Inputs

Outputs

dashboard_alarm_threshold_modify

[Family: cluster]

This command is removed starting from ONTAP 9.0.

Inputs

Outputs

diagnosis_alert_definition_get

[Family: cluster]

Return alert definition

Inputs

Outputs

diagnosis_alert_definition_get_iter

[Family: cluster]

Iterate over a list of Alert Definition objects.

Inputs

Outputs

diagnosis_alert_get

[Family: cluster]

Return a subsystem alert

Inputs

Outputs

diagnosis_alert_get_iter

[Family: cluster]

Iterate over a list of Alert Information objects.

Inputs

Outputs

diagnosis_alert_modify

[Family: cluster]

Acknowledge/suppress an alert

Inputs

Outputs

diagnosis_config_get

[Family: cluster]

Return the system health framework configuration

Inputs

Outputs

diagnosis_config_get_iter

[Family: cluster]

Iterate over a list of Health Monitor Configuration objects.

Inputs

Outputs

diagnosis_delete_alert

[Family: cluster]

Delete subsystem alert

Inputs

Outputs

diagnosis_policy_definition_get

[Family: cluster]

Return policy definition

Inputs

Outputs

diagnosis_policy_definition_get_iter

[Family: cluster]

Iterate over a list of Policy Definition objects.

Inputs

Outputs

diagnosis_policy_modify

[Family: cluster]

Enable/disable policy

Inputs

Outputs

diagnosis_status_get

[Family: cluster]

Return the overall system health

Inputs

Outputs

diagnosis_subscriptions_create

[Family: cluster]

Create a new Subscriptions for Notifications.

Inputs

Outputs

diagnosis_subscriptions_get

[Family: cluster]

Return system health subscription

Inputs

Outputs

diagnosis_subscriptions_get_iter

[Family: cluster]

Iterate over a list of Subscriptions for Notifications objects.

Inputs

Outputs

diagnosis_subscriptions_modify

[Family: cluster]

Modify system health subscription

Inputs

Outputs

diagnosis_subsystem_config_get

[Family: cluster]

Get the attributes of the Health Monitor Subsystem Status.

Inputs

Outputs

diagnosis_subsystem_config_get_iter

[Family: cluster]

Iterate over a list of Health Monitor Subsystem Status objects.

Inputs

Outputs

diagnosis_subsystem_config_modify

[Family: cluster]

Modify system health subsystem

Inputs

Outputs

disk_fail

[Family: cluster]

Fail a file system disk. Removes the specified file system disk from the RAID configuration, spinning the disk down when removal is complete. disk fail is used to remove a file system disk that may be logging excessive errors and requires replacement. Note that if optional input parameter 'is-immediate' is true, the specified disk will be immediately failed out, and the RAID group to which the disk belongs will enter degraded mode (meaning a disk is missing from the RAID group). If a spare disk at least as large as the disk being removed is available, the contents of the disk being removed will be reconstructed onto that spare disk. If 'is-immediate' options is false or not specified, system will prefail the disk and its content will be copied to a replacement disk if a suitable spare disk is available, and afterwards the prefailed disk will be failed out. This process can be observed by polling disk-list-info for this disk and tracking values of elements copy-destination and copy-percent. Same can be done using 'storage-disk-get-iter' when requested from Admin Vserver LIF. The disk being failed is marked as ``broken'', so that if it remains in the disk shelf, it will not be used by the filer as a spare disk. If the disk is moved to another filer, that filer will use it as a spare. This is not a recommended course of action, as the reason that the disk was failed may have been because it needed to be replaced. NOTE: Data ONTAP 7.0 and earlier releases don't indicate failure code properly.

Inputs

Outputs

disk_remove

[Family: cluster]

Remove a spare disk. Removes the specified spare disk from the RAID configuration, spinning the disk down when removal is complete. You can use disk remove to remove a spare disk so that it can be used by another filer (as a replacement for a failed disk or to expand file system space). NOTE: Data ONTAP 7.0 and earlier releases don't indicate failure code properly.

Inputs

Outputs

disk_replace_start

[Family: cluster]

Initiate replacing a file system disk with an appropriate spare disk. Uses Rapid RAID Recovery to copy data from the source file system disk to the destination spare disk. Roles of disks are reversed at the end of that process. The spare disk will replace the file system disk in the RAID group and the file system disk will become a spare. This interface returns as soon as possible while disk replace starts in the background. This process can be observed by polling disk-list-info for this disk and tracking values of elements copy-destination and copy-percent. Note: The operation performs limited error checking. Disk replace starts asynchronously in the background, and it can fail even if ZAPI reports success.

Inputs

Outputs

disk_replace_stop

[Family: cluster]

Abort disk replace.

Inputs

Outputs

disk_sanown_assign

[Family: cluster]

Assigns ownership of a disk. The normal usage is when the disk is unowned, or to assign a disk to a pool.

Inputs

Outputs

disk_sanown_filer_list_info

[Family: cluster]

Get sanown filer information.

Inputs

Outputs

disk_sanown_list_info

[Family: cluster]

Get sanown disk information. This API is not supported as of Data ONTAP 8.2. Use storage-disk-get-iter instead.

Inputs

Outputs

disk_sanown_reassign

[Family: cluster]

Changes ownership on disks already belonging to an owner.

Inputs

Outputs

disk_sanown_remove_ownership

[Family: cluster]

Removes ownership information on a disks provided by disk-list.

Inputs

Outputs

disk_unfail

[Family: cluster]

Unfail a disk in the broken pool, by clearing its FDR (Failed Disk Registry) entry and unfailing it at the Storage Layer, as necessary. If the "make-spare" option is set to B_TRUE, the disk is returned to the spare pool. Otherwise, label assimilation will bring the disk back according to its on-disk labels, with one of four possible outcomes. 1. Disk becomes a spare. This is the common case. The disk becomes a spare upon unfail, because its parent volume is complete and online. 2. Disk is assimilated into former volume. This is a recovery scenario. The disk is brought back into an existing volume, which may result in this volume coming back online. 3. Disk is assimilated into a new partial volume. This may occur in the rare case that the disk's former volume was destroyed or moved. 4. Disk returned to broken pool. This is the case if a fatal error occurs in process of unfailing the disk.

Inputs

Outputs

disk_update_disk_fw

[Family: cluster]

Start disk firmware download process to update firmware on disks. This operation is asynchronous, and therefore returns no errors that might occur during the download process. This operation will only update firmware on disks that do not have the latest firmware revision. The firmware revision on the disk can be monitored via the disk-list-info API.

Inputs

Outputs

disk_zero_spares

[Family: cluster]

Set up all non-zeroed spares owned by the filer to start zeroing. This operation is asynchronous, and therefore returns no errors that might occur when the zeroing operation actually starts, which could be several seconds after this API operation completes. Zeroing progress can be monitored via the disk-list-info API. Same can be done using 'storage-disk-get-iter' when requested from Admin Vserver LIF. The "zeroing-percent" element of disk-detail-info is returned if disk zeroing has started, and "is-zeroed" returns TRUE once the zeroing has completed (or, if zeroing wasn't necessary in the first place).

Inputs

Outputs

disk_encrypt_get

[Family: cluster]

Return data key ID, FIPS key ID and protection mode of a self-encrypting disk.

Inputs

Outputs

disk_encrypt_get_iter

[Family: cluster]

Return data key ID, FIPS key ID and protection mode of one or more self-encrypting disks.

Inputs

Outputs

disk_encrypt_modify

[Family: cluster]

The disk-encrypt-modify API alters encryption parameters on a self-encrypting disk (SED).

The API output <results status="passed"> indicates only that the operation has started. Monitor operation progress using the disk-encrypt-status-get or disk-encrypt-status-get-iter API.

Inputs

Outputs

disk_encrypt_modify_iter

[Family: cluster]

The disk-encrypt-modify-iter API alters encryption parameters on one or more self-encrypting disks (SEDs).

The API output <results status="passed"> indicates only that the operation has started. Monitor operation progress using the disk-encrypt-status-get or disk-encrypt-status-get-iter API.

Inputs

Outputs

disk_encrypt_sanitize

[Family: cluster]

The disk-encrypt-sanitize API cryptographically erases a self-encrypting disk (SED) that is in the spare or broken state.

The API output <results status="passed"> indicates only that the operation has started. Monitor operation progress using the disk-encrypt-status-get or disk-encrypt-status-get-iter API.

Inputs

Outputs

disk_encrypt_sanitize_iter

[Family: cluster]

The disk-encrypt-sanitize-iter API cryptographically erases one or more self-encrypting disks that are in the spare or broken state.

The API output <results status="passed"> indicates only that the operation has started. Monitor operation progress using the disk-encrypt-status-get or disk-encrypt-status-get-iter API.

Inputs

Outputs

disk_encrypt_status_get

[Family: cluster]

Return information about the latest self-encrypting disk command for a node.

Inputs

Outputs

disk_encrypt_status_get_iter

[Family: cluster]

Return information about the latest self-encrypting disk command for one or more nodes.

Inputs

Outputs

ems_autosupport_log

[Family: vserver]

This API is used by SnapDrive to log SnapDrive specific events occurring on a host system to the the appliance and optionally use the appliance to generate an autosupport message. This event information will be encapsulated in an app.log.x EMS event based on error level. If auto-support is true, an autosupport message will be sent from the filer.

Inputs

Outputs

ems_config_get

[Family: cluster]

Return the EMS Configuration.

Inputs

Outputs

ems_config_modify

[Family: cluster]

Modify the EMS Configuration.

Inputs

Outputs

ems_config_set_proxy_password

[Family: cluster]

Modify the password for proxy server

Inputs

Outputs

ems_destination_create

[Family: cluster]

(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Creates an EMS destination.

Inputs

Outputs

ems_destination_destroy

[Family: cluster]

(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Deletes the specified EMS destination.

Inputs

Outputs

ems_destination_destroy_iter

[Family: cluster]

(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Deletes several EMS destinations.

Inputs

Outputs

ems_destination_get

[Family: cluster]

(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Return the specified EMS destination information.

Inputs

Outputs

ems_destination_get_iter

[Family: cluster]

(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Return information on EMS destinations.

Inputs

Outputs

ems_destination_modify

[Family: cluster]

(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Modifies the specified EMS destination.

Inputs

Outputs

ems_destination_modify_iter

[Family: cluster]

(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Modifies several EMS destinations.

Inputs

Outputs

ems_event_catalog_get_iter

[Family: cluster]

Return information on several EMS messages.

Inputs

Outputs

ems_event_filter_copy

[Family: cluster]

Copy an Event filter including all its rules

Inputs

Outputs

ems_event_filter_create

[Family: cluster]

Create a new event filter.

Inputs

Outputs

ems_event_filter_destroy_iter

[Family: cluster]

Delete one or more existing event filters. To delete the event notifications associated with the filter as well, set the force flag.

Inputs

Outputs

ems_event_filter_get_iter

[Family: cluster]

Iterate over a list of event filters.

Inputs

Outputs

ems_event_filter_rename

[Family: cluster]

Rename an Event filter

Inputs

Outputs

ems_event_filter_rule_add

[Family: cluster]

Add a rule to an event filter

Inputs

Outputs

ems_event_filter_rule_delete

[Family: cluster]

Delete a rule for an event filter

Inputs

Outputs

ems_event_filter_rule_reorder

[Family: cluster]

Reorder the rules based on the new position for a given rule

Inputs

Outputs

ems_event_filter_test

[Family: cluster]

Test an event filter

Inputs

Outputs

ems_event_notification_create

[Family: cluster]

Create an event notification

Inputs

Outputs

ems_event_notification_destination_check

[Family: cluster]

Check connectivity to an event notification destination

Inputs

Outputs

ems_event_notification_destination_create

[Family: cluster]

Create an event notification destination

Inputs

Outputs

ems_event_notification_destination_destroy_iter

[Family: cluster]

Delete one or more existing event destinations

Inputs

Outputs

ems_event_notification_destination_get_iter

[Family: cluster]

Returns information about one or more event notification destinations. The fields is-server-ca-present, certificate-authority, certificate-serial and is-certificate-valid are only applicable for a destination of type 'rest-api' and the destination being an HTTPS destination.

Inputs

Outputs

ems_event_notification_destination_modify_iter

[Family: cluster]

Modify one or more event notification destinations

Inputs

Outputs

ems_event_notification_destroy_iter

[Family: cluster]

Delete one or more event notifications

Inputs

Outputs

ems_event_notification_get_iter

[Family: cluster]

Returns information about one or more event notifications

Inputs

Outputs

ems_event_notification_history_get_iter

[Family: cluster]

Return EMS messages sent to a destination.

Inputs

Outputs

ems_event_notification_modify_iter

[Family: cluster]

Modify one or more event notifications

Inputs

Outputs

ems_mail_history_destroy

[Family: cluster]

(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Delete an individual mail history entry.

Inputs

Outputs

ems_mail_history_destroy_iter

[Family: cluster]

(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Delete mail history entries.

Inputs

Outputs

ems_mail_history_get

[Family: cluster]

(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Return an individual mail history entry.

Inputs

Outputs

ems_mail_history_get_iter

[Family: cluster]

(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Return information mail history.

Inputs

Outputs

ems_message_get

[Family: cluster]

Return an EMS message.

Inputs

Outputs

ems_message_get_iter

[Family: cluster]

Return EMS messages.

Inputs

Outputs

ems_routing_add_destination

[Family: cluster]

(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Add EMS Destinations.

Inputs

Outputs

ems_routing_get

[Family: cluster]

(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Return the specified EMS route information. In general, specifying the severity input parameter is not needed. If specified, it must match that of the event identified by the message-name input parameter.

Inputs

Outputs

ems_routing_get_iter

[Family: cluster]

(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Return information on several EMS routes.

Inputs

Outputs

ems_routing_modify

[Family: cluster]

(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Modifies the specified EMS route.

Inputs

Outputs

ems_routing_modify_iter

[Family: cluster]

(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Modifies several EMS route.

Inputs

Outputs

ems_routing_remove_destination

[Family: cluster]

(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Remote EMS Destinations.

Inputs

Outputs

ems_snmp_history_destroy

[Family: cluster]

(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Delete an individual SNMP history entry.

Inputs

Outputs

ems_snmp_history_destroy_iter

[Family: cluster]

(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Delete SNMP history entries.

Inputs

Outputs

ems_snmp_history_get

[Family: cluster]

(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Return an individual SNMP history entry.

Inputs

Outputs

ems_snmp_history_get_iter

[Family: cluster]

(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Return information SNMP history.

Inputs

Outputs

ems_status_get

[Family: cluster]

Return information on an EMS message.

Inputs

Outputs

ems_status_get_iter

[Family: cluster]

Return information on EMS messages.

Inputs

Outputs

environment_sensors_get_iter

[Family: cluster]

Returns the sensors information from the environmental subsystem.

Inputs

Outputs

export_check_access_get_iter

[Family: cluster, vserver]

Shows the access information for supplied client

Inputs

Outputs

export_policy_create

[Family: vserver]

Create an Export policy configuration.

Inputs

Outputs

export_policy_destroy

[Family: vserver]

Delete an Export policy configuration.

Inputs

Outputs

export_policy_get

[Family: vserver]

Get an Export policy configuration.

Inputs

Outputs

export_policy_get_iter

[Family: cluster, vserver]

Get a group of Export policy configurations.

Inputs

Outputs

export_policy_rename

[Family: vserver]

Rename an Export policy

Inputs

Outputs

export_rule_add_clientmatches

[Family: vserver]

Add list of clientmatch strings to an existing export-policy rule

Inputs

Outputs

export_rule_create

[Family: vserver]

Create an Export rule configuration.

Inputs

Outputs

export_rule_destroy

[Family: vserver]

Delete an Export rule configuration.

Inputs

Outputs

export_rule_get

[Family: vserver]

Get an Export rule configuration.

Inputs

Outputs

export_rule_get_create_defaults

[Family: cluster, vserver]

Obtain the default values for Export rule configuration

Inputs

Outputs

export_rule_get_iter

[Family: cluster, vserver]

Get a group of Export rule configurations.

Inputs

Outputs

export_rule_modify

[Family: vserver]

Modify an Export rule configuration.

Inputs

Outputs

export_rule_remove_clientmatches

[Family: vserver]

Remove clientmatch strings from an existing export-policy rule

Inputs

Outputs

export_rule_set_index

[Family: vserver]

Move a rule to the specified index

Inputs

Outputs

exports_access_cache_all_vservers_get

[Family: cluster]

Get the NFS Exports Access Cache Refresh Periods.This API is deprecated in Data ONTAP 9.0.0 and later.

Inputs

Outputs

exports_access_cache_all_vservers_modify

[Family: cluster]

Modify the NFS Exports Access Cache Refresh Periods. This API is deprecated in Data ONTAP 9.0.0 and later.

Inputs

Outputs

exports_access_cache_config_get

[Family: vserver]

Get the exports access cache configuration for the given Vserver.

Inputs

Outputs

exports_access_cache_config_get_iter

[Family: cluster, vserver]

Iterate over the list of Vservers for exports access cache configuration.

Inputs

Outputs

exports_access_cache_config_modify

[Family: vserver]

Modify the exports access cache configuration for the given Vserver.

Inputs

Outputs

fc_config_adapter_disable

[Family: cluster]

Call the corresponding adapter driver disable function to bring the adapter offline. Under some circumstances an adapter can not be put offline. (e.g. when the adapter is being used by the RAID sub-system to provide disks in a volume). In some cases, manual intervention is required. When this happens, an appropriate error messages is returned.

Inputs

Outputs

fc_config_adapter_enable

[Family: cluster]

Call the corresponding adapter driver enable function to bring the adapter online. Under some circumstances an adapter can not be brought online. (e.g. when that adapter is in the UNCONFIGURED state, or when there is no cable attached to the adapter port). When this happens, an appropriate error messages is returned.

Inputs

Outputs

fc_config_list_info

[Family: cluster]

Iterate over a list of fc objects.

Inputs

Outputs

fc_config_set_adapter_fc_type

[Family: cluster]

fc-config-set-adapter-fc-type changes the adapter driver and/or configuration state. Each configurable adapter has an adapter-type and adapter-state. The adapter-type indicates which driver is attached to the adapter, the adapter-state indicates what the configuration state of the adapter is. The fc-type is used to modify both the adapter-type and the adapter-state. After setting the adapter fc-type a filer reboot is sometimes needed to make the change effective. Use fc-config-list-info to determine if a filer reboot is needed.

Inputs

Outputs

fcp_adapter_config_down

[Family: cluster]

Bring a Fibre Channel target adapter offline. The adapter may not be offline immediately after the call returns, it may take up to a few seconds for the adapter to change state. In Data ONTAP 7-Mode, if the FCP service is not running then all adapters are automatically offlined. They cannot be brought online again until FCP service is started. adapter to change state. In Data ONTAP Cluster-Mode, offlining an adapter will operationally disable all FCP logical interfaces (LIFs) hosted by the adapter.

Inputs

Outputs

fcp_adapter_config_up

[Family: cluster]

Bring a Fibre Channel target adapter online. The adapter may not be online immediately after the call returns, it may take up to a few seconds for the adapter to initialize. In Data ONTAP 7-Mode, if the FCP service is not running then all adapters are automatically offlined. They cannot be brought online again until FCP service is started. In Data ONTAP Cluster-Mode, offlining an adapter will operationally disable all FCP logical interfaces (LIFs) hosted by the adapter.

Inputs

Outputs

fcp_adapter_get_iter

[Family: cluster]

Iterate over the list of physical FC adapters.

Inputs

Outputs

fcp_adapter_set_speed

[Family: cluster]

Sets the speed on the Fibre Channel target adapter. It can be configured to run at 1Gb, 2Gb, 4Gb, 8Gb, 10Gb, 16Gb or to auto negotiate. The 10Gb adapter only supports the 10Gb speed. The 16Gb adapter only supports speeds of 16Gb, 8Gb, and 4Gb. The 8Gb adapter only supports speeds of 8Gb, 4Gb, and 2Gb. The 4Gb adapter only supports speeds of 4Gb, 2Gb, and 1Gb. If the adapter is online it must be brought offline before setting the speed, and then online in order for a new speed to take effect. This may temporarily disrupt fcp service on the target adapter.

Inputs

Outputs

fcp_adapter_stats_get_iter

[Family: cluster]

Iterate over a list of fcp objects.

Inputs

Outputs

fcp_initiator_get_iter

[Family: cluster, vserver]

List all initiators connected to FCP target LIFs.

Inputs

Outputs

fcp_interface_get_iter

[Family: cluster, vserver]

Iterate over a list of FCP Target Logical Interfaces (LIF).

Inputs

Outputs

fcp_nameserver_get_iter

[Family: cluster, vserver]

Iterates over the list of entries in the fabric name server database.

Inputs

Outputs

fcp_node_get_name

[Family: vserver]

Get the current FCP World Wide Node Name (WWNN). This WWNN name is in the form XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit. In Data ONTAP 7-Mode, this is the WWNN of the individual storage system. In "single_image" cfmode, the WWNN of the system and its high availability partner will be the same. In Data ONTAP Cluster-Mode, this is the WWNN of the Vserver FCP Service.

Inputs

Outputs

fcp_node_set_name

[Family: vserver]

Set the current FCP World Wide Node Name (WWNN). This WWNN is in the form XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit. The provided WWNN must also be within one of the allowed vendor-registered namespaces unless the force parameter is specified. In Data ONTAP 7-Mode, all Fibre Channel adapters must be offline. The allowed vendor namespace is "50:0a:09:80:8X:XX:XX". Changes will take place when the adapters are brought online. In Data ONTAP Cluster-Mode, the FCP service must be offline. The allowed vendor namespace is one of following: Changes will take place when the service is brought online.

Inputs

Outputs

fcp_ping_igroup_view_get_iter

[Family: cluster, vserver]

Iterate over a list of FCP ping igroup results objects.

Inputs

Outputs

fcp_ping_initiator_get_iter

[Family: cluster, vserver]

Iterate over a list of FCP ping by FCP initiator objects.

Inputs

Outputs

fcp_port_name_get_iter

[Family: cluster, vserver]

Iterate over the list of valid Fibre Channel target port names on a Vserver's FCP LIFs.

Inputs

Outputs

fcp_port_name_set

[Family: vserver]

Set a valid but unused port name on a Fibre Channel target interface.

Inputs

Outputs

fcp_service_create

[Family: vserver]

Create an FCP Service in a Vserver. Each Vserver requires an online FCP Service in order to serve data via the Fibre Channel protocol.

Inputs

Outputs

fcp_service_destroy

[Family: vserver]

Destroy the FCP Service in a Vserver.

Inputs

Outputs

fcp_service_get_iter

[Family: cluster, vserver]

Iterate over the list of FCP Services.

Inputs

Outputs

fcp_service_start

[Family: vserver]

Starts FCP service. When FCP service is started, the adapters are brought online. The service will be available once the call returns with success. The adapters however, may not be available immediately after the call, it may take up to a few seconds for the adapters to initialize.

Inputs

Outputs

fcp_service_status

[Family: vserver]

Get status of the FCP service, whether or not it is running.

Inputs

Outputs

fcp_service_stop

[Family: vserver]

Stops FCP service. When FCP service is stopped, the adapters are brought offline. The service will be unavailable once the call returns with success.

Inputs

Outputs

fcp_topology_get_iter

[Family: cluster, vserver]

Iterates over the list of FCP topology interconnect elements.

Inputs

Outputs

fcp_topology_port_get_iter

[Family: cluster]

Iterates over the list of entries in the fabric name server database.

Inputs

Outputs

fcp_wwpnalias_get_iter

[Family: cluster, vserver]

Iterate over the list of assigned World Wide Port Name (WWPN) aliases.

Inputs

Outputs

fcp_wwpnalias_remove

[Family: vserver]

Remove an alias for a World Wide Port Name of an initiator. Either the alias or the wwpn argument must be provided.

Inputs

Outputs

fcp_wwpnalias_set

[Family: vserver]

Set an alias for a World Wide Port Name of an initiator that might login to the target.

Inputs

Outputs

fcp_zone_get_iter

[Family: cluster]

Iterates over the list of entries in the fabric name server database.

Inputs

Outputs

fcport_get_link_state

[Family: cluster]

Get the link state of a specific adapter on this system.

Inputs

Outputs

feature_status_list_info

[Family: cluster, vserver]

Returns status information for managed features.

Inputs

Outputs

feature_usage_get_iter

[Family: cluster]

Returns feature usage information for DATA ONTAP features. The feature usage information is reported on a per controller node basis.

Inputs

Outputs

feature_usage_summary_get_iter

[Family: cluster]

Returns feature usage summary information for DATA ONTAP features. The feature usage information is reported on a per controller node basis.

Inputs

Outputs

file_assign_qos

[Family: cluster]

Manage the association of QoS policy group to a specified file. QoS Policy groups define measurable Service Level Objectives (SLOs) that apply to the storage object with which the policy group is associated. In Data ONTAP 8.2 hierarchical QoS is not supported i.e. QoS policy groups cannot be assigned to multiple objects in the file's storage hierarchy - such as the parent LUN, volume or Vserver.

Inputs

Outputs

file_compact_data

[Family: cluster]

compact data

Inputs

Outputs

file_create_directory

[Family: vserver]

Create a directory.

Inputs

Outputs

file_create_symlink

[Family: vserver]

Create a symlink.

Inputs

Outputs

file_delete_directory

[Family: vserver]

Delete a directory.

Inputs

Outputs

file_delete_file

[Family: vserver]

Delete a file.

Inputs

Outputs

file_fingerprint_abort

[Family: cluster, vserver]

The file-fingerprint-abort API can be used to abort an ongoing fingerprint operation. This api only aborts the fingerprint operations that have been started and have not finished. You identify the session-id with this API, and it aborts the fingerprint operation that is associated with that particular session-id. You must specify session-id when using file-fingerprint-abort.

Inputs

Outputs

file_fingerprint_dump

[Family: cluster, vserver]

The file-fingerprint-dump API returns the fingerprint information for a file. The session-id must be specified when using the file-fingerprint-dump API.This is the session-id of the fingerprint operation that is returned when a fingerprint operation is started using the file-fingerprint-start API. If the fingerprint operation is complete, it will also show the complete fingerprint information for the file.

Inputs

Outputs

file_fingerprint_get_iter

[Family: cluster, vserver]

The file-fingerprint-get-iter API returns information for one or several fingerprint operations. We need to specify either session-id or vserver-name and volume-name with the file-fingerprint-get-iter API. When queried with session-id, the file-fingerprint-get-iter API returns the progress of the fingerprint operation with the specified session-id. When queried with vserver-name and volume-name, the file-fingerprint-get-iter API returns the progress of all the fingerprint operations running on that particular volume.

Inputs

Outputs

file_fingerprint_start

[Family: vserver]

The file-fingerprint-start API is used to start the fingerprint computation a file. The fingerprint computation is started on the file, and a session-id is returned. This session-id is an unique identifier for the fingerprint operation. To start the fingerprint computation on a file, the following parameters should be compulsarily specified:

Inputs

Outputs

file_get_file_info

[Family: vserver]

Obtains the file information or properties.

Inputs

Outputs

file_get_space_reservation_info

[Family: vserver]

Queries the space reservation settings for the named file.

This API is not supported for Infinite Volumes.

Inputs

Outputs

file_hole_range_query_iter

[Family: vserver]

Return ranges of holes in a file

Inputs

Outputs

file_inode_info_get_iter

[Family: vserver]

Get information about all the files associated with an inode in a volume.

Inputs

Outputs

file_list_directory_iter

[Family: vserver]

list of files in a given directory.

Inputs

Outputs

file_punch_hole_iter

[Family: vserver]

Punch hole in the file. Hole punching involves reclaiming of blocks in a file by unallocating them and then direct or indirect blocks can be made to point to 0.

Inputs

Outputs

file_read_file

[Family: vserver]

Read data from a named file. API will fail if length exceeds 1 MB. This API should only be used on normal files or streams associated with files. The results for other file types such as LUNs is undefined.

Inputs

Outputs

file_read_symlink

[Family: vserver]

Read the contents of a symlink.

Inputs

Outputs

file_rename_file

[Family: vserver]

Rename a file or directory. Note that this API cannot be used to rename to a different volume.

Inputs

Outputs

file_set_space_reservation_info

[Family: vserver]

Sets the space reservation settings for the named file. is-overwrite-enabled and is-fill-enabled both must be the same value.

This API is not supported for Infinite Volumes.

Inputs

Outputs

file_truncate_file

[Family: vserver]

Truncate a file. Any data past the truncation point will be lost, of course.

Inputs

Outputs

file_usage_get

[Family: vserver]

Reports unique bytes held in a file.

Inputs

Outputs

file_usage_result_get

[Family: vserver]

Used to poll and retrieve results for a previous file-usage-start call. EINPROGRESS indicates that the background job has not finished yet.

Inputs

Outputs

file_usage_start

[Family: vserver]

Starts a background job to compute unique bytes held in a file. The result can be obtained by passing the cookie to file-usage-result-get call.

Inputs

Outputs

file_write_file

[Family: vserver]

Write data into a named file. If the file/stream does not previously exist, it will be created - the owner of the file will be root and it will be readable but not writable by non-root users. API will fail if data exceeds 1 MB. This API should only be used on normal files or streams associated with files. The results for other file types such as LUNs is undefined.

Inputs

Outputs

file_directory_effective_permissions_get

[Family: vserver]

Gives information about the maximal access for the mentioned user on given path.

Inputs

Outputs

file_directory_security_get

[Family: vserver]

Returns security information of a file/folder

Inputs

Outputs

file_directory_security_ntfs_create

[Family: vserver]

Creates a new NTFS security descriptor

Inputs

Outputs

file_directory_security_ntfs_dacl_add

[Family: vserver]

Add a discretionary access control entry to NTFS security descriptor.

Inputs

Outputs

file_directory_security_ntfs_dacl_get_iter

[Family: cluster, vserver]

Returns information about one or more discretionary access control entries

Inputs

Outputs

file_directory_security_ntfs_dacl_modify

[Family: vserver]

Modify a discretionary access control entry of a file security descriptor

Inputs

Outputs

file_directory_security_ntfs_dacl_remove

[Family: vserver]

Remove a discretionary access control entry from NTFS security descriptor.

Inputs

Outputs

file_directory_security_ntfs_delete

[Family: vserver]

Deletes an NTFS security descriptor information

Inputs

Outputs

file_directory_security_ntfs_get_iter

[Family: cluster, vserver]

Returns information about one or more NTFS security descriptor

Inputs

Outputs

file_directory_security_ntfs_modify

[Family: vserver]

Modifies an NTFS security descriptor

Inputs

Outputs

file_directory_security_ntfs_sacl_add

[Family: vserver]

Add a system/audit access control entry to NTFS security descriptor.

Inputs

Outputs

file_directory_security_ntfs_sacl_get_iter

[Family: cluster, vserver]

Returns information about one or more system/audit access control entries

Inputs

Outputs

file_directory_security_ntfs_sacl_modify

[Family: vserver]

Modify an system/audit access control entry of a file security descriptor

Inputs

Outputs

file_directory_security_ntfs_sacl_remove

[Family: vserver]

Remove an system/audit access control entry from NTFS security descriptor.

Inputs

Outputs

file_directory_security_policy_create

[Family: vserver]

Creates a new file/folder security policy configuration. To preserve the security configuration of a file(or, folder) or set of files(or, folders) security policy has been defined. Policy is a container for tasks and a task associates a file/folder path name and the security descriptor that needs to be set on the file/folder. Every task in a policy is uniquely identified by the file/folder path. Policy can't have duplicate task entries and there is only one task per path.

Inputs

Outputs

file_directory_security_policy_delete

[Family: vserver]

Deletes a file/folder security policy. To preserve the security configuration of a file(or, folder) or set of files(or, folders) security policy has been defined. Policy is a container for tasks and a task associates a file/folder path name and the security descriptor that needs to be set on the file/folder. Every task in a policy is uniquely identified by the file/folder path. Policy can't have duplicate task entries and there is only one task per path.

Inputs

Outputs

file_directory_security_policy_get_iter

[Family: cluster, vserver]

Returns information about one or more security policies. To preserve the security configuration of a file(or, folder) or set of files(or, folders) security policy has been defined. Policy is a container for tasks and a task associates a file/folder path name and the security descriptor that needs to be set on the file/folder. Every task in a policy is uniquely identified by the file/folder path. Policy can't have duplicate task entries and there is only one task per path.

Inputs

Outputs

file_directory_security_policy_task_add

[Family: vserver]

Add a file security policy task. A task maps security descriptor with a file or folder.

Inputs

Outputs

file_directory_security_policy_task_get_iter

[Family: cluster, vserver]

Returns information about one or more policy tasks. Policy is a container for tasks and a task associates a file/folder path name and the security descriptor that needs to be set on the file/folder. Every task in a policy is uniquely identified by the file/folder path. Policy can't have duplicate task entries and there is only one task per path.

Inputs

Outputs

file_directory_security_policy_task_modify

[Family: vserver]

Modify a file security policy task

Inputs

Outputs

file_directory_security_policy_task_remove

[Family: vserver]

Remove a task from the policy of a vserver.

Inputs

Outputs

file_directory_security_remove_slag

[Family: vserver]

Removes SLAG from the specified volume or qtree path.

Inputs

Outputs

file_directory_security_set

[Family: vserver]

Apply security descriptors on files and directories defined in a policy to a Vserver

Inputs

Outputs

fileservice_audit_config_create

[Family: vserver]

Create audit configuration for a Vserver

Inputs

Outputs

fileservice_audit_config_get

[Family: vserver]

Show Audit configuration details for a Vserver

Inputs

Outputs

fileservice_audit_config_get_iter

[Family: cluster, vserver]

Show Audit configuration details for all Vservers

Inputs

Outputs

fileservice_audit_config_get_total_records

[Family: cluster]

Return the total number of records

Inputs

Outputs

fileservice_audit_config_modify

[Family: vserver]

Modify audit configuration for a Vserver

Inputs

Outputs

fileservice_audit_disable

[Family: vserver]

Disable Auditing for specified Vserver

Inputs

Outputs

fileservice_audit_enable

[Family: vserver]

Enable Auditing for specified Vserver.

Events on FlexGroup volumes will not be emitted to the audit log.

Inputs

Outputs

fileservice_audit_remove

[Family: vserver]

Disable Audit Configuration for specified vserver

Inputs

Outputs

fileservice_audit_repair

[Family: vserver]

Repair the audit infrastructure

Inputs

Outputs

fileservice_audit_rotate_log

[Family: vserver]

Rotate audit log for specified vserver

Inputs

Outputs

flash_get_thresholds

[Family: cluster]

Get threshold profiles available in Flash Management Module.

Inputs

Outputs

flash_thresholds_get_iter

[Family: cluster]

Iterate over a list of Flash Cache threshold profiles objects.

Inputs

Outputs

flash_device_get_iter

[Family: cluster]

Iterate over a list of Flash Cache device info objects.

Inputs

Outputs

flash_device_list_info

[Family: cluster]

Get a collection of Flash Cache device info objects.

Inputs

Outputs

flexcache_cache_policy_create

[Family: cluster]

Create a new flexcache-cache-policy.

Inputs

Outputs

flexcache_cache_policy_destroy

[Family: cluster]

Delete an existing flexcache-cache-policy object.

Inputs

Outputs

flexcache_cache_policy_get

[Family: cluster]

Get the attributes of the flexcache-cache-policy.

Inputs

Outputs

flexcache_cache_policy_get_iter

[Family: cluster]

Iterate over a list of flexcache-cache-policy objects.

Inputs

Outputs

flexcache_cache_policy_modify

[Family: cluster]

Modify the attributes of flexcache-cache-policy object.

Inputs

Outputs

flexcache_connected_cache_get_iter

[Family: cluster, vserver]

Retrieve connected cache information. This must be run at the origin cluster.

Inputs

Outputs

flexcache_create

[Family: cluster]

Create cluster-wide caching for a given volume.

Inputs

Outputs

flexcache_create_async

[Family: vserver]

Create a cache relationship. This must be run at the cache cluster.

Inputs

Outputs

flexcache_default_size_get

[Family: cluster]

Get recommended FlexCache size

Inputs

Outputs

flexcache_delete

[Family: cluster]

Delete cluster-wide caching for a given volume.

Inputs

Outputs

flexcache_destroy_async

[Family: vserver]

Delete a cache relationship. This must be run at the cache cluster. A job will be spawned to operate on the flexcache and the job id will be returned. The progress of the job can be tracked using the job APIs.

Inputs

Outputs

flexcache_get

[Family: vserver]

Get the attributes of the flexcache.

Inputs

Outputs

flexcache_get_iter

[Family: cluster, vserver]

Get a set of cache relationships. This must be run at the cache cluster.

Inputs

Outputs

flexcache_options_get

[Family: cluster]

Get the cluster-wide attributes of FlexCache.

Inputs

Outputs

flexcache_options_modify

[Family: cluster]

Modify the cluster-wide attributes of FlexCache.

Inputs

Outputs

flexcache_origin_cleanup_cache_relationship

[Family: vserver]

Cleanup cache relationship. This must be run at the origin cluster.

Inputs

Outputs

flexcache_usage_get

[Family: cluster]

Get the capacity used by FlexCache

Inputs

Outputs

fpolicy_disable_policy

[Family: vserver]

Disables a specific named policy.

Inputs

Outputs

fpolicy_enable_policy

[Family: vserver]

Enables a specific named policy. The operation will fail if the policy doesn't exist.

Inputs

Outputs

fpolicy_passthrough_read_connection_get_iter

[Family: cluster, vserver]

Returns passthrough-read connection status information.

Inputs

Outputs

fpolicy_policy_create

[Family: vserver]

Create a policy.

Inputs

Outputs

fpolicy_policy_delete

[Family: vserver]

Delete a policy.

Inputs

Outputs

fpolicy_policy_event_create

[Family: vserver]

Create FPolicy Event.

Inputs

Outputs

fpolicy_policy_event_delete

[Family: vserver]

Delete FPolicy event.

Inputs

Outputs

fpolicy_policy_event_get_iter

[Family: cluster, vserver]

Get a list of rows for FPolicy event options. FPolicy event is consist of protocol, file operations, vo lume operation and filters.

Inputs

Outputs

fpolicy_policy_event_modify

[Family: vserver]

Set FPolicy event options. FPolicy event is consist of protocol, file operation, volume operation and f ilters.

Inputs

Outputs

fpolicy_policy_external_engine_create

[Family: vserver]

Create an external engine.

Inputs

Outputs

fpolicy_policy_external_engine_delete

[Family: vserver]

Delete an external engine.

Inputs

Outputs

fpolicy_policy_external_engine_get_iter

[Family: cluster, vserver]

Returns information on external engines.

Inputs

Outputs

fpolicy_policy_external_engine_modify

[Family: vserver]

Modify an external engine. External engine can be modified only when none of the enabled policies are using it.

Inputs

Outputs

fpolicy_policy_get_iter

[Family: cluster, vserver]

Returns information about policies.

Inputs

Outputs

fpolicy_policy_modify

[Family: vserver]

Modify a policy.

Inputs

Outputs

fpolicy_policy_scope_create

[Family: vserver]

Set FPolicy scope options. FPolicy Scope is consist of share, volume, export policy, volume, file extention.

Inputs

Outputs

fpolicy_policy_scope_delete

[Family: vserver]

Delete a scope.

Inputs

Outputs

fpolicy_policy_scope_get_iter

[Family: cluster, vserver]

Get a list of rows for FPolicy scope options. FPolicy Scope consists of share, volume, export policy, volume, file extention.

Inputs

Outputs

fpolicy_policy_scope_modify

[Family: vserver]

Set FPolicy scope options. FPolicy Scope is consist of share, volume, export policy, volume, file extention.

Inputs

Outputs

fpolicy_policy_status_get_iter

[Family: cluster, vserver]

Returns FPolicy policy status information.

Inputs

Outputs

fpolicy_server_connect

[Family: vserver]

Make a connection to FPolicy server

Inputs

Outputs

fpolicy_server_disconnect

[Family: vserver]

Terminate connection to FPolicy server

Inputs

Outputs

fpolicy_server_status_get_iter

[Family: cluster, vserver]

Returns FPolicy server status information.

Inputs

Outputs

gpo_applied_info_get_iter

[Family: cluster, vserver]

Get the list of entries of the applied GPO rules, organized on a per-Vserver basis.

Inputs

Outputs

gpo_get_iter

[Family: cluster, vserver]

Retrieve the Vserver's group policy configuration.

Inputs

Outputs

gpo_gpresult_info_get_iter

[Family: cluster, vserver]

Get a list of entries of the GPO RSoP(Resultant Set of Policy) data, organized on a per-Vserver basis.

Inputs

Outputs

gpo_modify

[Family: vserver]

Change the Vserver's group policy configuration.

Inputs

Outputs

gpo_restricted_group_applied_info_get_iter

[Family: cluster, vserver]

Applied Restricted Group Settings

Inputs

Outputs

gpo_restricted_group_defined_info_get_iter

[Family: cluster, vserver]

Defined Restricted Group Settings in DC

Inputs

Outputs

gpo_update

[Family: vserver]

Download and apply the latest version of the group policy defined in Active Directory.

Inputs

Outputs

group_mapping_create

[Family: vserver]

This API is no longer supported as of ONTAP 9.5.0.

Create a new group mapping for a Vserver.

Inputs

Outputs

group_mapping_delete

[Family: vserver]

This API is no longer supported as of ONTAP 9.5.0.

Delete an existing group mapping entry.

Inputs

Outputs

group_mapping_get_iter

[Family: cluster, vserver]

This API is no longer supported as of ONTAP 9.5.0.

Retrieve the list of group mappings in the cluster.

Inputs

Outputs

group_mapping_insert

[Family: vserver]

This API is no longer supported as of ONTAP 9.5.0.

Insert a group mapping into the table at a specified position.

Inputs

Outputs

group_mapping_modify

[Family: vserver]

This API is no longer supported as of ONTAP 9.5.0.

Modify an existing group mapping entry.

Inputs

Outputs

group_mapping_swap

[Family: vserver]

This API is no longer supported as of ONTAP 9.5.0.

Swap the position of one group mapping with another. The position is the place in the sequence of group mappings in which the mappings are applied.

Inputs

Outputs

ha_interconnect_auto_reset_configuration_get_iter

[Family: cluster]

Iterate over list of nodes in the cluster to get their high-availability interconnect device auto-reset configuration information

Inputs

Outputs

ha_interconnect_channel_status_get_iter

[Family: cluster]

Iterate over list of nodes in the cluster to get their high-availability interconnect channel status

Inputs

Outputs

ha_interconnect_clear_port_counters

[Family: cluster]

Clear high-availability interconnect port counters of the selected node

Inputs

Outputs

ha_interconnect_clear_port_symbol_errors

[Family: cluster]

Clear high-availability interconnect port symbol errors of the selected node

Inputs

Outputs

ha_interconnect_config_details_get_iter

[Family: cluster]

Iterate over list of nodes in the cluster to get their high-availability interconnect device configuration information

Inputs

Outputs

ha_interconnect_connection_status_get_iter

[Family: cluster]

Iterate over list of nodes in the cluster to get their high-availability interconnect connection status

Inputs

Outputs

ha_interconnect_flint_flash_details_get_iter

[Family: cluster]

Iterate over list of nodes in the cluster to get their high-availability interconnect binary firmware image information residing in the flash card attached to adapter

Inputs

Outputs

ha_interconnect_flint_image_details_get_iter

[Family: cluster]

Iterate over list of nodes in the cluster to get their high-availability interconnect binary firmware image information residing in the system

Inputs

Outputs

ha_interconnect_flint_verify_flash

[Family: cluster]

Verify high-availability interconnect binary firmware image residing in flash card attached to adapter on the selected node

Inputs

Outputs

ha_interconnect_flint_verify_image

[Family: cluster]

Verify high-availability interconnect binary firmware image residing in system on the selected node

Inputs

Outputs

ha_interconnect_flush_details_get_iter

[Family: cluster]

Iterate over list of nodes in the cluster to get their high-availability interconnect device flush information

Inputs

Outputs

ha_interconnect_get_auto_reset_configuration

[Family: cluster]

Get high-availability interconnect device auto-reset configuration information of the selected node

Inputs

Outputs

ha_interconnect_get_channel_status

[Family: cluster]

Get high-availability interconnect channel status of the selected node

Inputs

Outputs

ha_interconnect_get_config_details

[Family: cluster]

Get high-availability interconnect device configuration information of the selected node

Inputs

Outputs

ha_interconnect_get_connection_status

[Family: cluster]

Get high-availability interconnect connection status of the selected node

Inputs

Outputs

ha_interconnect_get_flint_flash_details

[Family: cluster]

Get high-availability interconnect binary firmware image information residing in the flash card attached to adapter of the selected node

Inputs

Outputs

ha_interconnect_get_flint_image_details

[Family: cluster]

Get high-availability interconnect binary firmware image information residing in the system of the selected node

Inputs

Outputs

ha_interconnect_get_flush_details

[Family: cluster]

Get high-availability interconnect device flush information of the selected node

Inputs

Outputs

ha_interconnect_get_nvram_configuration

[Family: cluster]

Get basic nvram configuration information of the selected node

Inputs

Outputs

ha_interconnect_get_ood_status

[Family: cluster]

Get high-availability interconnect device out-of-order delivery information of the selected node

Inputs

Outputs

ha_interconnect_get_performance_statistics

[Family: cluster]

Get high-availability interconnect performance statistics of the selected node

Inputs

Outputs

ha_interconnect_get_port_details

[Family: cluster]

Get high-availability interconnect device port information of the selected node

Inputs

Outputs

ha_interconnect_get_scatter_gather_list_statistics

[Family: cluster]

Get high-availability interconnect device scatter-gather list entry statistics of the selected node

Inputs

Outputs

ha_interconnect_get_timeout_values

[Family: cluster]

Get high-availability interconnect software timeout values of the selected node

Inputs

Outputs

ha_interconnect_link_off

[Family: cluster]

Turn off selected interconnect link on the selected node

Inputs

Outputs

ha_interconnect_link_on

[Family: cluster]

Turn on selected interconnect link on the selected node

Inputs

Outputs

ha_interconnect_modify_auto_reset_configuration

[Family: cluster]

Change high-availability interconnect device auto-reset configuration of the selected node

Inputs

Outputs

ha_interconnect_modify_timeout_values

[Family: cluster]

Change high-availability interconnect software timeout values of the selected node

Inputs

Outputs

ha_interconnect_nic_reset

[Family: cluster]

Reset high-availability interconnect device of the selected node

Inputs

Outputs

ha_interconnect_nvram_configuration_get_iter

[Family: cluster]

Iterate over list of nodes in the cluster to get their basic nvram configuration information

Inputs

Outputs

ha_interconnect_ood_clear_error_statistics

[Family: cluster]

Clear high-availability interconnect device out-of-order delivery error statistics of the selected node

Inputs

Outputs

ha_interconnect_ood_clear_performance_statistics

[Family: cluster]

Clear high-availability interconnect device out-of-order delivery performance statistics of the selected node

Inputs

Outputs

ha_interconnect_ood_disable_statistics

[Family: cluster]

Disable high-availability interconnect device out-of-order delivery statistics collection for the selected node

Inputs

Outputs

ha_interconnect_ood_enable_statistics

[Family: cluster]

Enable high-availability interconnect device out-of-order delivery statistics collection for the selected node

Inputs

Outputs

ha_interconnect_ood_optimization_off

[Family: cluster]

Disable coalescing work requests on high-availability interconnect device of the selected node

Inputs

Outputs

ha_interconnect_ood_optimization_on

[Family: cluster]

Enable coalescing work requests on high-availability interconnect device of the selected node

Inputs

Outputs

ha_interconnect_ood_send_diagnostic_buffer

[Family: cluster]

Send diagnostic buffer to the HA partner of the selected node

Inputs

Outputs

ha_interconnect_ood_status_get_iter

[Family: cluster]

Iterate over list of nodes in the cluster to get their high-availability interconnect device out-of-order delivery information

Inputs

Outputs

ha_interconnect_performance_statistics_get_iter

[Family: cluster]

Iterate over list of nodes in the cluster to get their high-availability interconnect performance statistics

Inputs

Outputs

ha_interconnect_port_details_get_iter

[Family: cluster]

Iterate over list of nodes in the cluster to get their high-availability interconnect device port information

Inputs

Outputs

ha_interconnect_scatter_gather_list_statistics_get_iter

[Family: cluster]

Iterate over list of nodes in the cluster to get their high-availability interconnect device scatter-gather list entry statistics

Inputs

Outputs

ha_interconnect_timeout_values_get_iter

[Family: cluster]

Iterate over list of nodes in the cluster to get their high-availability interconnect software timeout values

Inputs

Outputs

igroup_add

[Family: vserver]

Adds initiator to an existing initiator group.

Inputs

Outputs

igroup_bind_portset

[Family: vserver]

Bind an existing igroup to a given portset.

Inputs

Outputs

igroup_create

[Family: vserver]

Creates a new initiator group. In Data ONTAP 7.3 and upto ONTAP 8.0, the ALUA (Asymmetric Logical Unit Access) attribute will be enabled by default if initiator-group-type is "fcp" and os-type is "aix", "hpux", or "linux. In Data ONTAP 7-mode 8.1 and later, the ALUA attribute is enabled by default for all os-type if initiator-group-type is "fcp". In Data ONTAP Cluster-Mode 8.1 and later, the ALUA attribute is enabled by default on all initiator groups.

Inputs

Outputs

igroup_destroy

[Family: vserver]

Destroys an existing initiator group. By default a group cannot be destroyed if there are existing lun maps defined for that group. This behaviour can be overridden with the use of force option set to "true" which will destroy the initiator group and any associated lun maps.

Inputs

Outputs

igroup_get_iter

[Family: cluster, vserver]

Iterate over a list of igroup objects.

Inputs

Outputs

igroup_lookup_lun

[Family: vserver]

Find the path to the lun mapped at a given lun-id for a given initiator group.

Inputs

Outputs

igroup_os_type_list

[Family: cluster]

Displays the supported values and descriptions for initiator-group-os-type.

Inputs

Outputs

igroup_remove

[Family: vserver]

Removes node(s) from an initiator group. The operation is prohibited if there are existing lun maps defined for that group. The force option set to "true" can be used to forcibly remove the node regardless of mappings.

Inputs

Outputs

igroup_rename

[Family: vserver]

Rename an existing initiator group. The rename operation is non-disruptive.

Inputs

Outputs

igroup_set_attribute

[Family: vserver]

Sets an attribute for an initiator group.

Inputs

Outputs

igroup_unbind_portset

[Family: vserver]

Unbind an existing igroup from a portset.

Inputs

Outputs

iscsi_auth_add_initiator_address_ranges

[Family: vserver]

Add one or more Initiator IP Address Ranges

Inputs

Outputs

iscsi_auth_generate_chap_password

[Family: vserver]

Generate a 128 bit random password that can be used as a CHAP secret. This API was removed in Data ONTAP 9.0. Applications should use local entropy to generate CHAP secrets if desired.

Inputs

Outputs

iscsi_auth_remove_initiator_address_ranges

[Family: vserver]

Remove one or more Initiator IP Address Ranges

Inputs

Outputs

iscsi_connection_get_iter

[Family: cluster, vserver]

Iterate over a list of iSCSI Connection objects.

Inputs

Outputs

iscsi_initiator_add_auth

[Family: vserver]

Add initiator to the authentication list.

Inputs

Outputs

iscsi_initiator_auth_get_iter

[Family: cluster, vserver]

Iterate over a list of iSCSI initiator authentication configuration objects.

Inputs

Outputs

iscsi_initiator_delete_auth

[Family: vserver]

Delete initiator from the authentication list

Inputs

Outputs

iscsi_initiator_get_auth

[Family: vserver]

Get the authentication info for an initiator, if auth type is CHAP, only the user-name is returned, password is not returned for security purposes.

Inputs

Outputs

iscsi_initiator_get_default_auth

[Family: vserver]

Get the default authentication information for iscsi. If the authentication type is CHAP, only the username is returned, and not the password, for security purposes.

Inputs

Outputs

iscsi_initiator_get_iter

[Family: cluster, vserver]

Iterate over a list of remote iSCSI initiator objects.

Inputs

Outputs

iscsi_initiator_modify_chap_params

[Family: vserver]

Modify CHAP parameters to an existing per-initiator authentication info whose auth-type equals CHAP.

Inputs

Outputs

iscsi_initiator_set_default_auth

[Family: vserver]

Configure the default authentication method. If an initiator is not configured with a specific authentication method using iscsi-initiator-add-auth the default authentication method will be applied to it.

Inputs

Outputs

iscsi_interface_accesslist_add

[Family: vserver]

Add the iSCSI LIFs to the accesslist of the specified initiator

Inputs

Outputs

iscsi_interface_accesslist_get_iter

[Family: cluster, vserver]

Iterate over a list of iSCSI Interface Accesslist objects.

Inputs

Outputs

iscsi_interface_accesslist_remove

[Family: vserver]

Remove the iSCSI LIFs from the accesslist of the specified initiator

Inputs

Outputs

iscsi_interface_disable

[Family: vserver]

Disables an interface for use by iSCSI

Inputs

Outputs

iscsi_interface_enable

[Family: vserver]

Enables an interface for use by iSCSI

Inputs

Outputs

iscsi_interface_get_iter

[Family: cluster, vserver]

Iterate over a list of iSCSI target interface objects.

Inputs

Outputs

iscsi_interface_modify

[Family: vserver]

Modify the attributes of an iSCSI interface object.

Inputs

Outputs

iscsi_isns_config

[Family: vserver]

Configures the iSNS service. In Data ONTAP Cluster-Mode, this this API can only modify the configuration of a Vserver where an iSNS service has already been created. To create an iSNS service in a Vserver where one does not exist, use the iscsi-isns-create API.

Inputs

Outputs

iscsi_isns_create

[Family: vserver]

Create iSNS Service in a Vserver.

Inputs

Outputs

iscsi_isns_destroy

[Family: vserver]

Destroy the iSNS Service in a Vserver.

Inputs

Outputs

iscsi_isns_get_info

[Family: vserver]

Gets iSNS service configuration.

Inputs

Outputs

iscsi_isns_get_iter

[Family: cluster, vserver]

Gets iSNS service configuration.

Inputs

Outputs

iscsi_isns_start

[Family: vserver]

Start iSNS service. The service will be available once the call returns with success.

Inputs

Outputs

iscsi_isns_stop

[Family: vserver]

Stops iSNS service. Service will not be available once the call returns with success.

Inputs

Outputs

iscsi_isns_update

[Family: vserver]

Forces iSNS service to update server.

Inputs

Outputs

iscsi_node_get_name

[Family: vserver]

Return the current iscsi node name.

Inputs

Outputs

iscsi_node_set_name

[Family: vserver]

Set the current iscsi node name.

Inputs

Outputs

iscsi_service_create

[Family: vserver]

Create an iSCSI Service in a Vserver. Each Vserver requires an online iSCSI Service in order to serve data via the iSCSI protocol.

Inputs

Outputs

iscsi_service_destroy

[Family: vserver]

Destroy the iSCSI Service in a Vserver.

Inputs

Outputs

iscsi_service_get_iter

[Family: cluster, vserver]

Iterate over the list of iSCSI Services.

Inputs

Outputs

iscsi_service_modify

[Family: vserver]

Modify an iSCSI Service in a Vserver.

Inputs

Outputs

iscsi_service_start

[Family: vserver]

Start iSCSI service. The service will be available once the call returns with success.

Inputs

Outputs

iscsi_service_status

[Family: vserver]

Get status of the iSCSI service, whether or not it is running.

Inputs

Outputs

iscsi_service_stop

[Family: vserver]

Stops iSCSI service. Service will be not be available once the call returns with success.

Inputs

Outputs

iscsi_session_get_iter

[Family: cluster, vserver]

Iterate over a list of iSCSI session objects.

Inputs

Outputs

iscsi_stats_get_iter

[Family: cluster, vserver]

Iterate over a list of iscsi objects.

Inputs

Outputs

iscsi_target_alias_clear_alias

[Family: vserver]

Clear the current iscsi target alias

Inputs

Outputs

iscsi_target_alias_get_alias

[Family: vserver]

Return the current iscsi target alias

Inputs

Outputs

iscsi_target_alias_set_alias

[Family: vserver]

Set the current iscsi target alias

Inputs

Outputs

iscsi_tpgroup_create

[Family: vserver]

Create a new user defined target portal group.

Inputs

Outputs

iscsi_tpgroup_destroy

[Family: vserver]

Destroy a tpgroup. Only user defined target portal groups may be destroyed.

Inputs

Outputs

iscsi_tpgroup_get_iter

[Family: cluster, vserver]

Iterate over a list of iSCSI Target Portal Group objects.

Inputs

Outputs

iscsi_tpgroup_interface_add

[Family: vserver]

Add an interface to a target portal group. Interfaces may only be added to a user defined target portal group.

Inputs

Outputs

iscsi_tpgroup_interface_delete

[Family: vserver]

Remove an interface from a target portal group. Interfaces may only be removed from a user defined target portal group. Removing an interface will return it to the system defined default group for the interface.

Inputs

Outputs

job_by_node_get

[Family: vserver]

Get a single job entry. This is just a performance optimization for job-get that only searches for the job among the ones currently owned by the given node.

Inputs

Outputs

job_by_node_get_iter

[Family: cluster, vserver]

Get multiple job records organized by node. This is just a performance optimization for job-get-iter that only searches for the job among the ones currently owned by the given node.

Inputs

Outputs

job_completed_get

[Family: vserver]

Get a single completed job entry. This is just a performance optimization for job-get.

Inputs

Outputs

job_completed_get_iter

[Family: cluster, vserver]

Get multiple completed job records. This is just a performance optimization for job-get-iter.

Inputs

Outputs

job_get

[Family: vserver]

Get a single job entry.

Inputs

Outputs

job_get_iter

[Family: cluster, vserver]

Get multiple job records.

Inputs

Outputs

job_history_get

[Family: vserver]

Get a single job history event.

Inputs

Outputs

job_history_get_iter

[Family: cluster, vserver]

Get multiple job history records.

Inputs

Outputs

job_pause

[Family: vserver]

Pause a job. A job must be of a type that has job-type-is-pausible set to true before it may be paused. Once notified of a pause request, a job should stop performing work until it is subsequently resumed.

Inputs

Outputs

job_pause_iter

[Family: cluster, vserver]

Pause a collection of jobs.

Inputs

Outputs

job_private_completed_get

[Family: vserver]

Get a single completed, private job entry. This is just a performance optimization for job-private-get.

Inputs

Outputs

job_private_completed_get_iter

[Family: cluster, vserver]

Get multiple completed, private job records. This is just a performance optimization for job-private-get-iter.

Inputs

Outputs

job_private_get

[Family: vserver]

Get a single private job entry.

Inputs

Outputs

job_private_get_iter

[Family: cluster, vserver]

Get multiple private job records.

Inputs

Outputs

job_private_pause

[Family: vserver]

Pause a private job.

Inputs

Outputs

job_private_pause_iter

[Family: cluster, vserver]

Pause a collection of private jobs.

Inputs

Outputs

job_private_resume

[Family: vserver]

Resume a job.

Inputs

Outputs

job_private_resume_iter

[Family: cluster, vserver]

Resume a collection of jobs.

Inputs

Outputs

job_private_soft_pause

[Family: vserver]

Soft pause a private job.

Inputs

Outputs

job_private_soft_pause_iter

[Family: cluster, vserver]

Soft pause a collection of private jobs.

Inputs

Outputs

job_private_stop

[Family: vserver]

Stop a job.

Inputs

Outputs

job_private_stop_iter

[Family: cluster, vserver]

Stop a collection of jobs.

Inputs

Outputs

job_queue_config_get

[Family: cluster]

Get the job queue configuration

Inputs

Outputs

job_queue_config_modify

[Family: cluster]

Modify the job queue configuration

Inputs

Outputs

job_resume

[Family: vserver]

Resume a job from the paused state.

Inputs

Outputs

job_resume_iter

[Family: cluster, vserver]

Resume a collection of jobs.

Inputs

Outputs

job_schedule_cron_create

[Family: cluster, vserver]

Create a new cron job schedule entry.

Inputs

Outputs

job_schedule_cron_destroy

[Family: cluster, vserver]

Delete a single cron job schedule entry. The entry must not be in use.

Inputs

Outputs

job_schedule_cron_destroy_iter

[Family: cluster, vserver]

Delete multiple cron job schedule entries. The entries must not be in use.

Inputs

Outputs

job_schedule_cron_get

[Family: cluster, vserver]

Get a single cron job schedule entry.

Inputs

Outputs

job_schedule_cron_get_iter

[Family: cluster, vserver]

Get multiple cron job schedule entries.

Inputs

Outputs

job_schedule_cron_modify

[Family: cluster, vserver]

Modify an existing cron job schedule entry.

Inputs

Outputs

job_schedule_get

[Family: cluster, vserver]

Get a single job schedule entry.

Inputs

Outputs

job_schedule_get_iter

[Family: cluster, vserver]

Get multiple job schedule entries.

Inputs

Outputs

job_schedule_interval_create

[Family: cluster, vserver]

Create a new interval job schedule entry.

Inputs

Outputs

job_schedule_interval_destroy

[Family: cluster, vserver]

Delete a single interval job schedule entry. The entry must not be in use.

Inputs

Outputs

job_schedule_interval_destroy_iter

[Family: cluster, vserver]

Delete multiple interval job schedule entries. The entries must not be in use.

Inputs

Outputs

job_schedule_interval_get

[Family: cluster, vserver]

Get a single interval job schedule entry.

Inputs

Outputs

job_schedule_interval_get_iter

[Family: cluster, vserver]

Get multiple interval job schedule entries.

Inputs

Outputs

job_schedule_interval_modify

[Family: cluster, vserver]

Modify an existing interval job schedule entry.

Inputs

Outputs

job_soft_pause

[Family: vserver]

Soft pause a job. Indicates to the job that a soft pause has been initiated. It is up to the job to do what it needs to do for a soft pause. As a result of this command the job may request to be moved into the runnnable queue to perform further processing of the soft pause.

Inputs

Outputs

job_soft_pause_iter

[Family: cluster, vserver]

Soft pause a collection of jobs.

Inputs

Outputs

job_stop

[Family: vserver]

Stop a job. A job must be of a type that has job-type-is-quittable set to true before it may be stopped. job-stop attempts to stop a job that's currently running. If the job allows itself to stop it completes its current run. If the job has a recurring schedule it will transition to the Queued state; otherwise it will transition into either the Success or Failure state.

Inputs

Outputs

job_stop_iter

[Family: cluster, vserver]

Stop a collection of jobs.

Inputs

Outputs

kerberos_config_get

[Family: vserver]

Get Kerberos configuration information for a LIF.

Inputs

Outputs

kerberos_config_get_iter

[Family: cluster, vserver]

Get Kerberos configuration information for a group of LIFs.

Inputs

Outputs

kerberos_config_modify

[Family: vserver]

Modify Kerberos configuration information for a LIF

Inputs

Outputs

kerberos_realm_create

[Family: vserver]

Create a new Kerberos realm configuration.

In Data ONTAP 8.2.x and prior versions, Kerberos realms were owned by Cserver and were accessible only from Admin Vserver LIFs using the input 'config-name'. The 'vserver' input was not required.

Starting from Data ONTAP 8.3.0, Kerberos realms are owned by data Vservers and are accessible from both Admin and data Vserver LIFs. The 'config-name' input can no longer be used as a key. The 'realm' input must be used instead. The 'vserver' input is required.

Inputs

Outputs

kerberos_realm_delete

[Family: vserver]

Delete the Kerberos realm configuration.

In Data ONTAP 8.2.x and prior versions, Kerberos realms were owned by Cserver and were accessible only from Admin Vserver LIFs using the input 'config-name'. The 'vserver' input was not required.

Starting from Data ONTAP 8.3.0, Kerberos realms are owned by data Vservers and are accessible from both Admin and data Vserver LIFs. The 'config-name' input can no longer be used as a key. The 'realm' input must be used instead. The 'vserver' input is required.

Inputs

Outputs

kerberos_realm_get_iter

[Family: cluster, vserver]

Retrieve the list of Kerberos realm configurations.

Inputs

Outputs

kerberos_realm_modify

[Family: vserver]

Modify the Kerberos realm configuration.

In Data ONTAP 8.2.x and prior versions, Kerberos realms were owned by Cserver and were accessible only from Admin Vserver LIFs using the input 'config-name'. The 'vserver' input was not required.

Starting from Data ONTAP 8.3.0, Kerberos realms are owned by data Vservers and are accessible from both Admin and data Vserver LIFs. The 'config-name' input can no longer be used as a key. The 'realm' input must be used instead. The 'vserver' input is required.

Inputs

Outputs

ldap_check_get_iter

[Family: cluster, vserver]

Display the status of an LDAP configuration

Inputs

Outputs

ldap_client_create

[Family: vserver]

Create a new Lightweight Directory Access Protocol (LDAP) client configuration for the cluster.

Inputs

Outputs

ldap_client_delete

[Family: vserver]

Delete an existing Lightweight Directory Access Protocol (LDAP) client configuration from the cluster.

Inputs

Outputs

ldap_client_get_iter

[Family: cluster, vserver]

Retrieve the list of Lightweight Directory Access Protocol (LDAP) client configurations for the cluster.

Inputs

Outputs

ldap_client_modify

[Family: vserver]

Modify an existing Lightweight Directory Access Protocol (LDAP) client configuration.

Inputs

Outputs

ldap_client_schema_copy

[Family: vserver]

Copy an existing LDAP schema. If the LDAP server that the storage system needs to query does not support any of the default read-only schemas, this API can be used to create an editable copy of an existing read-only schema. After copying the schema, the copy can be modified using the ldap-client-schema-modify API.

Inputs

Outputs

ldap_client_schema_delete

[Family: vserver]

Delete an existing Lightweight Directory Access Protocol (LDAP) schema configuration. Only the schemas that are defined using the ldap-client-schema-copy API can be deleted using this API.

Inputs

Outputs

ldap_client_schema_get_iter

[Family: cluster, vserver]

Retrieve the list of Lightweight Directory Access Protocol (LDAP) client schema configurations that are defined for the cluster.

Inputs

Outputs

ldap_client_schema_modify

[Family: vserver]

Modify an existing Lightweight Directory Access Protocol (LDAP) schema configuration. If the LDAP server that the storage system needs to query does not support any of the default read-only schemas, the ldap-client-schema-copy API can be used to create a editable copy of an existing read-only schema. After copying the schema, the copy can be modified using this API to support the target schema.

Inputs

Outputs

ldap_config_create

[Family: vserver]

Create a new association between a Lightweight Directory Access Protocol (LDAP) client configuration and a Vserver. A Vserver can have only one client configuration associated with it.

Inputs

Outputs

ldap_config_delete

[Family: vserver]

Delete a Vserver's association with a Lightweight Directory Access Protocol (LDAP) configuration.

Inputs

Outputs

ldap_config_get_iter

[Family: cluster, vserver]

Retrieve the list of Lightweight Directory Access Protocol (LDAP) configurations in the cluster.

Inputs

Outputs

ldap_config_modify

[Family: vserver]

Modify the Lightweight Directory Access Protocol (LDAP) configuration for a Vserver.

Inputs

Outputs

license_v2_add

[Family: cluster]

Add license for a Data ONTAP service.

Inputs

Outputs

license_v2_apply

[Family: cluster]

Add entitlements described in license content

Inputs

Outputs

license_v2_capacity_create

[Family: cluster]

Adds V2 capacity license.

Inputs

Outputs

license_v2_capacity_get_iter

[Family: cluster]

Get V2 capacity license information. This command is deprecated in Data ONTAP 9.2 and may be removed in a future release.

Inputs

Outputs

license_v2_capacity_pool_get_iter

[Family: cluster]

Returns capacity pool usage information for each cluster aggregate.

Inputs

Outputs

license_v2_cleanup_list_info

[Family: cluster]

Returns licenses that can be cleaned up. A license can be cleaned up if it's a demo license and its expiration time has passed (expired), or if it is a license for a controller that is no longer part of a cluster (unused). One can use the cleanup apis to remove these licenses together, or alternatively, they can use the standard license-remove api to remove them one at a time.

Inputs

Outputs

license_v2_delete

[Family: cluster]

Removes license for a Data ONTAP service.

Inputs

Outputs

license_v2_delete_expired

[Family: cluster]

Remove licenses that have expired in the cluster.

Inputs

Outputs

license_v2_delete_unused

[Family: cluster]

Remove licenses that have no controller affiliation in the cluster.

Inputs

Outputs

license_v2_entitlement_risk_get_iter

[Family: cluster]

Returns license entitlement risk for cluster mode packages.

Inputs

Outputs

license_v2_leases_update

[Family: cluster]

Attempt to reconcile capacity leases

Inputs

Outputs

license_v2_license_manager_config_get

[Family: cluster]

Get license manager configuration

Inputs

Outputs

license_v2_license_manager_config_modify

[Family: cluster]

Modify license manager configuration

Inputs

Outputs

license_v2_license_manager_status_get_iter

[Family: cluster]

Check accessibility of license manager

Inputs

Outputs

license_v2_list_info

[Family: cluster]

Returns infomation for DATA ONTAP licenses.

Inputs

Outputs

license_v2_status_get_iter

[Family: cluster]

Get Data ONTAP licenses status information.

Inputs

Outputs

license_v2_status_list_info

[Family: cluster]

Returns license status information for cluster mode packages. This command is deprecated in Data ONTAP 9.2 and may be removed in a future release.

Inputs

Outputs

license_v2_subscription_create

[Family: cluster]

Add V2 subscription license.

Inputs

Outputs

license_v2_subscription_get_iter

[Family: cluster]

Get V2 subscription license information.

Inputs

Outputs

system_license_aggregate_get_iter

[Family: cluster]

Get Data ONTAP aggregate license information.

Inputs

Outputs

lock_break_iter

[Family: cluster, vserver]

Breaks one or more locks in the cluster that match the query.

Inputs

Outputs

lock_get_iter

[Family: cluster, vserver]

Returns information for one or more locks in the cluster that match the query.

Inputs

Outputs

lun_alignment_get_iter

[Family: cluster, vserver]

Iterate over a list of lun objects.

Inputs

Outputs

lun_alignment_reset_statistics

[Family: vserver]

Reset LUN Alignment Statistics

Inputs

Outputs

lun_clear_persistent_reservation_info

[Family: vserver]

Clear the SCSI-2 reservation or SCSI-3 persistent reservation information for a given LUN. Note: In Data ONTAP Cluster-Mode, the LUN must either be offline or not mapped to clear the persistent reservation information.

Inputs

Outputs

lun_copy_cancel

[Family: cluster, vserver]

Cancels an ongoing LUN copy operation prior to creation of the new LUN. This operation will fail if the LUN already exists at the destination path; in that case, use the lun-destroy API to delete the LUN at the destination path.

Inputs

Outputs

lun_copy_get_iter

[Family: cluster, vserver]

Iterate over a list of LUN copy job detail objects.

Inputs

Outputs

lun_copy_modify

[Family: cluster, vserver]

Modifies the maximum throughput of an ongoing copy operation.

Inputs

Outputs

lun_copy_pause

[Family: cluster, vserver]

Pauses an ongoing LUN copy operation. Use the lun-copy-resume API to resume the copy operation.

Inputs

Outputs

lun_copy_resume

[Family: cluster, vserver]

Resumes a paused LUN copy operation.

Inputs

Outputs

lun_copy_start

[Family: cluster, vserver]

Starts copying a group of LUNs from one volume to another. The destination volume can be located on the same Vserver as the original volume or on a different Vserver. If source-vserver is not specified, the source Vserver defaults to the target Vserver, i.e., an intra-Vserver copy. Intra-Vserver copy can be initiated by both cluster and Vserver administrators. Inter-Vserver copy can be initiated by cluster administrators only. Note: A cluster administrator must first create a Vserver peer relationship using vserver-peer-create API before a Vserver administrator can copy over LUNs from another Vserver in the cluster. This restriction does not apply to cluster administrators. Cluster administrators can initiate inter-Vserver LUN copy operations without creating a Vserver peer relationship.

Inputs

Outputs

lun_create_by_size

[Family: vserver]

Create a new lun of given size, with initially zero contents. The lun is created at the path given. No file should already exist at the given path. The directory specified in the path must be a qtree root directory. The size of the created lun could be larger than the size specified, in order to get an integral number of cylinders while reporting the geometry using SAN protocols.

Inputs

Outputs

lun_create_from_file

[Family: vserver]

Create a lun from an existing file. A new lun is created, at the given lun path (which must be at a qtree root). A hard link is created to the existing file. The file contents are not copied or changed. The file can be resized to a larger size, rounding up to a cylinder boundary. NOTE: LUNs created from files cannot be relocated.

Inputs

Outputs

lun_destroy

[Family: vserver]

Destroy the specified LUN. This operation will fail if the LUN is currently mapped and is online. The force option can be used to destroy it regardless of being online or mapped.

Inputs

Outputs

lun_generate_serial

[Family: cluster, vserver]

Generate a LUN Serial Number for later use.

Inputs

Outputs

lun_get_attribute

[Family: vserver]

Get a named attribute for a given LUN.

Inputs

Outputs

lun_get_attributes

[Family: vserver]

Get named attributes for a given LUN.

Inputs

Outputs

lun_get_comment

[Family: vserver]

Get the optional descriptive comment for a LUN.

Inputs

Outputs

lun_get_geometry

[Family: vserver]

Get SCSI disk geometry for a given LUN.

Inputs

Outputs

lun_get_inquiry_info

[Family: vserver]

Get the SCSI INQUIRY response data for vendor id (vid), product id (pid), and firmware revision (rev) based on the igroup that the lun in question is mapped to.

Inputs

Outputs

lun_get_iter

[Family: cluster, vserver]

Iterate over a list of lun objects.

Inputs

Outputs

lun_get_maxsize

[Family: vserver]

Returns the maximum possible size in bytes of a lun on a given volume or qtree. The user can pass the path to a volume or qtree in which the lun is to be created. This returns the maximum size for different types of LUNs and the possible maximum size with or without snapshot reserves.

Inputs

Outputs

lun_get_minsize

[Family: vserver]

Returns the minimum possible size in bytes. This returns the minimum size for different types of LUNs (based on the specified OS type). Space reservation does not affect the minimum lun size, thus only a single minimum size is returned.

Inputs

Outputs

lun_get_occupied_size

[Family: vserver]

Get the size occupied by the LUN in the active FS.

Inputs

Outputs

lun_get_persistent_reservation_info

[Family: vserver]

Get the persistent reservation information for a given LUN.

Inputs

Outputs

lun_get_select_attribute

[Family: vserver]

Get the select attribute for the specified LUN.

Inputs

Outputs

lun_get_serial_number

[Family: vserver]

Get the serial number for the specified LUN. Prior to Data ONTAP 8.1 release, the serial number is a 12-character string formed of upper and lower-case letters, numbers, and slash (/) and hyphen (-) characters. Starting Data ONTAP 8.1 release, the serial number is a 12-character string formed of upper and lower-case letters, numbers, and the characters /-#$%&*+<=>?[!]^~@ .

Inputs

Outputs

lun_get_space_reservation_info

[Family: vserver]

Queries the space reservation settings for the named LUN.

Inputs

Outputs

lun_get_vdisk_attributes

[Family: cluster, vserver]

Lookup a LUN path and storage system by serial number.

Inputs

Outputs

lun_has_scsi_reservations

[Family: vserver]

Queries for all types of scsi reservations covering both iSCSI and FCP.

Inputs

Outputs

lun_import_create

[Family: cluster]

Create a LUN import relationship with the purpose of importing foreign disk data into the LUN.

Inputs

Outputs

lun_import_delete

[Family: cluster]

Deletes the import relationship of the specified LUN or the specified foreign disk.

Inputs

Outputs

lun_import_get_iter

[Family: cluster]

Iterate over a list of LUN objects that are in a relationship with a foreign disk.

Inputs

Outputs

lun_import_pause

[Family: cluster]

Pause the import for the specified LUN.

Inputs

Outputs

lun_import_resume

[Family: cluster]

Resume the import for the specified LUN.

Inputs

Outputs

lun_import_start

[Family: cluster]

Start the import for the specified LUN.

Inputs

Outputs

lun_import_stop

[Family: cluster]

Stop and abort the import for the specified LUN. All import checkpoint data will be lost.

Inputs

Outputs

lun_import_throttle

[Family: cluster]

Modify the max throughput limit for the specified import relationship

Inputs

Outputs

lun_import_verify_start

[Family: cluster]

Start the verification of the foreign disk and LUN data. The import admin/operational state must be stopped/stopped or started/completed. The verification does a block for block comparison of the LUN and foreign disk. If the verification detects a mismatch between the foreign disk and LUN then the verify will stop.

Inputs

Outputs

lun_import_verify_stop

[Family: cluster]

Stop the verify for the specified LUN.

Inputs

Outputs

lun_initiator_list_map_info

[Family: cluster, vserver]

List all the LUNs mapped to an initiator

Inputs

Outputs

lun_initiator_logged_in

[Family: vserver]

Determine if an initiator is logged in via FCP or iSCSI.

Inputs

Outputs

lun_map

[Family: vserver]

Maps the LUN to all the initiators in the specified initiator group.

Inputs

Outputs

lun_map_add_reporting_nodes

[Family: vserver]

Add nodes to the list reporting the LUN map. If no specific action is provided, adds all the nodes in the current failover group for the LUN.

Inputs

Outputs

lun_map_get_iter

[Family: cluster, vserver]

Iterate over a list of LUN map detail objects.

Inputs

Outputs

lun_map_list_info

[Family: vserver]

Returns a list of initiator groups and their members (the initiators) mapped to the given LUN.

Inputs

Outputs

lun_map_remove_reporting_nodes

[Family: vserver]

Remove nodes from the list reporting the LUN map. If no specific action is provided, remove all nodes not in the current failover group for the LUN.

Inputs

Outputs

lun_move

[Family: vserver]

Move (rename) a LUN.

Inputs

Outputs

lun_move_cancel

[Family: vserver]

Cancels an ongoing LUN move operation prior to creation of the new LUN. This operation will fail if the LUN already exists at the destination path; in that case, allow the current move operation to complete and then move it back using the lun-move-start API.

Inputs

Outputs

lun_move_get_iter

[Family: cluster, vserver]

Iterate over a list of LUN move job detail objects.

Inputs

Outputs

lun_move_modify

[Family: vserver]

Modifies the maximum throughput of an ongoing move operation.

Inputs

Outputs

lun_move_pause

[Family: vserver]

Pauses an ongoing LUN move operation. Use the lun-move-resume API to resume the move operation.

Inputs

Outputs

lun_move_resume

[Family: vserver]

Resumes a paused LUN move operation.

Inputs

Outputs

lun_move_start

[Family: vserver]

Starts a LUN move operation to move one or more LUNs from one volume to another within a Vserver. The destination volume can be located on the same node as the source volume or on a different node. NOTE: LUNs created from files cannot be moved.

Inputs

Outputs

lun_offline

[Family: vserver]

Disables block-protocol accesses to the LUN. Mappings, if any, configured for the lun are not altered. Note that unless explicitly offlined, a lun is online.

Inputs

Outputs

lun_online

[Family: vserver]

Re-enables block-protocol accesses to the lun.

Inputs

Outputs

lun_os_type_list

[Family: cluster]

Displays the supported values and descriptions for lun-os-type.

Inputs

Outputs

lun_port_has_scsi_reservations

[Family: vserver]

Queries for all types of scsi reservations covering both iSCSI and FCP for a given initiator name. Initiator name can be FCP portname in case of FCP or iSCSI node name for iSCSI.

Inputs

Outputs

lun_resize

[Family: vserver]

Changes the size of the LUN. Note that client-side operations may be needed to ensure that client software recognizes the changed size. For Data ONTAP Cluster-Mode 8.3 and later, LUN resize is not allowed while the LUN is in import relationship with a Foreign LUN.

Inputs

Outputs

lun_set_attribute

[Family: vserver]

Set a named attribute for a given LUN. Attributes are arbitrary key/value pairs for application-defined use.

Inputs

Outputs

lun_set_comment

[Family: vserver]

Set the optional descriptive comment for a LUN.

Inputs

Outputs

lun_set_device_id

[Family: vserver]

Set a SCSI peripheral device identifying information value on a LUN. In Data ONTAP 7-Mode, the value set will be returned in response to the vendor unique SCSI command GET DEV ID. In Data ONTAP Cluster-Mode, the value set will be returned in response to the SCSI command REPORT IDENTIFYING INFORMATION for the appropriate INFORMATION TYPE: Either or both peripheral device identifying information values may be set or cleared independently.

Inputs

Outputs

lun_set_qos_policy_group

[Family: vserver]

null

Inputs

Outputs

lun_set_select_attribute

[Family: vserver]

Set the select attribute for the specified LUN. The select attribute is used by multi-pathing software to discriminate between LUNs when mirrored or cloned copies of a vdisk are mapped to the same host.

Inputs

Outputs

lun_set_serial_number

[Family: vserver]

Set the serial number for the specified LUN. The lun must first be made offline before changing the serial number. Prior to Data ONTAP 8.1 release, the serial number is a 12-character string formed of upper and lower-case letters, numbers, and slash (/) and hyphen (-) characters. Starting Data ONTAP 8.1 release, the serial number is a 12-character string formed of upper and lower-case letters, numbers, and the characters /-#$%&*+<=>?[!]^~@ .

Inputs

Outputs

lun_set_space_alloc

[Family: vserver]

Modify the attributes of lun object.

Inputs

Outputs

lun_set_space_reservation_info

[Family: vserver]

Sets the space reservation settings for the named LUN.

Inputs

Outputs

lun_stats_get_iter

[Family: cluster, vserver]

Iterate over a list of lun objects.

Inputs

Outputs

lun_unmap

[Family: vserver]

Reverses the effect of lun-map on the specified LUN for the specified group. For Data ONTAP Cluster-Mode 8.3 and later, if LUN is in import relationship, the last LUN map can not be deleted.

Inputs

Outputs

lun_unset_attribute

[Family: vserver]

Clear a named attribute for a given LUN.

Inputs

Outputs

lun_unset_device_id

[Family: vserver]

Remove a SCSI peripheral device identifying information value from a LUN.

Inputs

Outputs

metrocluster_check_aggregate_eligibility_get

[Family: cluster]

This API returns information regarding the eligibility of aggregates to host configuration replication volumes used for the replication of metrocluster configuration data.

Inputs

Outputs

metrocluster_check_aggregate_eligibility_get_iter

[Family: cluster]

This API returns information regarding the eligibility of aggregates to host configuration replication volumes used for the replication of metrocluster configuration data.

Inputs

Outputs

metrocluster_check_aggregate_get_iter

[Family: cluster]

Iterate over a list of metrocluster-check-aggregate-info objects

Inputs

Outputs

metrocluster_check_capture_status_get

[Family: cluster]

This API returns information regarding the capture status of replicated metrocluster configuration data.

Inputs

Outputs

metrocluster_check_cluster_get_iter

[Family: cluster]

Iterate over a list of metrocluster-check-cluster-info objects

Inputs

Outputs

metrocluster_check_config_replication_get

[Family: cluster]

Obtain the results of the MetroCluster config replication checks.

Inputs

Outputs

metrocluster_check_get_iter

[Family: cluster]

Iterate over a list of metrocluster-check-info objects.

Inputs

Outputs

metrocluster_check_lif_repair_placement

[Family: cluster]

The MetroCluster-check-lif-repair-placement API verifies LIF placement in the destination cluster for the sync-source Vserver LIF in a MetroCluster setup.

Inputs

Outputs

metrocluster_check_lif_update_vserver_name

[Family: cluster]

The MetroCluster-check-lif-update-vserver-name API updates the Vserver name for failed LIF placement entries for Vserver LIFs after the Vserver has been renamed in a MetroCluster setup.

Inputs

Outputs

metrocluster_check_node_get_iter

[Family: cluster]

Iterate over a list of metrocluster-check-node-info objects

Inputs

Outputs

metrocluster_check_run

[Family: cluster]

The metrocluster-check-run API starts a check on the metrocluster configuration. A job will be spawned to operate on the metrocluster and the job id will be returned. The progress of the job can be tracked using the job APIs.

Inputs

Outputs

metrocluster_check_volume_get_iter

[Family: cluster]

Iterate over a list of metrocluster-check-volume objects

Inputs

Outputs

metrocluster_config_diff_get

[Family: cluster]

Provides the differences in attributes of a specified configuration instance between two clusters in DR relationship for MetroCluster. This helps in verifying if the configuration of interest is replicated correctly from source cluster to destination cluster. If the source configuration matches that of destination, EOBJECTNOTFOUND is returned, indicating that the difference is nil. This API can be invoked on the source cluster or destination cluster. Note: The configuration objects replicated as part of MetroCluster and their keys can potentially change from release to release. If a program has opted to use those as inputs for selection, it may have to be adjusted for updated versions of Data ONTAP.

Inputs

Outputs

metrocluster_config_diff_get_iter

[Family: cluster]

Provides the differences in configuration between two clusters in DR relationship for MetroCluster. If an object is not specified, the differences for all replicated objects are shown. If the source configuration matches that of destination, EOBJECTNOTFOUND is returned, indicating that the difference is nil. This API can be invoked on the source cluster or destination cluster. Note: The configuration objects replicated as part of MetroCluster and their keys can potentially change from release to release. If a program has opted to use those as inputs for selection, it may have to be adjusted for updated versions of Data ONTAP.

Inputs

Outputs

metrocluster_config_replication_cluster_storage_configuration_get

[Family: cluster]

The metrocluster-config-replication-cluster-storage-configuration-get API returns information regarding the configuration of the cluster-wide storage associated with cross-cluster replication of metrocluster configuration data.

On Data ONTAP 8.3, metrocluster cannot be enabled simultaneously with Async Vserver DR. For this reason this command will return an error if Async Vserver DR is currently enabled on the cluster.

Inputs

Outputs

metrocluster_config_replication_cluster_storage_configuration_modify

[Family: cluster]

The metrocluster-config-replication-cluster-storage-configuration-modify API modifies nformation regarding the configuration of the cluster-wide storage associated with cross-cluster replication of metrocluster configuration data.

If input is not provided for a particular value, then the item is not modified in the storage configuration.

On Data ONTAP 8.3, metrocluster cannot be enabled simultaneously with Async Vserver DR. For this reason this command will return an error if Async Vserver DR is currently enabled on the cluster.

Inputs

Outputs

metrocluster_config_replication_resync_status_get

[Family: cluster]

Get MetroCluster configuration replication synchronization information

Inputs

Outputs

metrocluster_configure

[Family: cluster]

The metrocluster-configure API configures a node and its DR partner to mirror NVRAM and be configured to participate in a DR switchover. A job will be spawned to operate on the metrocluster and the job id will be returned. The progress of the job can be tracked using the job APIs.

Inputs

Outputs

metrocluster_create_periodic_job

[Family: cluster]

The create-periodic-job API creates the periodic check job.

Inputs

Outputs

metrocluster_delete_periodic_job

[Family: cluster]

The delete-periodic-job API deletes the periodic check job.

Inputs

Outputs

metrocluster_disable_periodic_check

[Family: cluster]

The metrocluster-disable-periodic-check API disables periodic check on the metrocluster configuration.

Inputs

Outputs

metrocluster_enable_periodic_check

[Family: cluster]

The enable-periodic-check API enables periodic check on the metrocluster configuration.

Inputs

Outputs

metrocluster_get

[Family: cluster]

Get MetroCluster configuration information

Inputs

Outputs

metrocluster_heal

[Family: cluster]

The metrocluster-heal API heals aggregates and partner roots in preparation for a DR switchback. Healing of aggregates and partner roots is done in two phases by the admin. DR partner nodes must be powered off and remote disk shelves must be powered on before calling this API. A job will be spawned to operate on the metrocluster and the job id will be returned. The progress of the job can be tracked using the job APIs.

Inputs

Outputs

metrocluster_interconnect_adapter_get_iter

[Family: cluster]

Iterate over a list of metrocluster-interconnect-adapter objects.

Inputs

Outputs

metrocluster_interconnect_ipfo_get_iter

[Family: cluster]

Iterate over a list of metrocluster-interconnect-ipfo objects.

Inputs

Outputs

metrocluster_interconnect_mirror_get_iter

[Family: cluster]

Iterate over a list of metrocluster-interconnect-mirror objects.

Inputs

Outputs

metrocluster_interconnect_mirror_multipath_get_iter

[Family: cluster]

Iterate over a list of metrocluster-interconnect-mirror-multipath objects.

Inputs

Outputs

metrocluster_interconnect_remotecluster_get_iter

[Family: cluster]

Get MetroCluster Interconnect Remote Cluster Reachable

Inputs

Outputs

metrocluster_is_configured

[Family: cluster]

The metrocluster-is-configured API returns a value indicating if the cluster is configured for MetroCluster.

Inputs

Outputs

metrocluster_node_get_iter

[Family: cluster]

Iterate over a list of metrocluster-node-info objects belonging to MetroCluster nodes

Inputs

Outputs

metrocluster_operation_get_iter

[Family: cluster]

Iterate over a list of MetroCluster operations and their details

Inputs

Outputs

metrocluster_operation_statistics_get_iter

[Family: cluster]

Iterate over a list of Metrocluster operation statistics.

Inputs

Outputs

metrocluster_progress_table_get_iter

[Family: cluster]

Iterate over a list of metrocluster-progress-table-info objects.

Inputs

Outputs

metrocluster_show_lif_placement_failures_get_iter

[Family: cluster]

Iterate over a list of LIF placement failures in a MetroCluster setup.

Inputs

Outputs

metrocluster_switchback

[Family: cluster]

The metrocluster-switchback API initiates the switchback of storage and client access from nodes in the DR site to their home nodes. The home nodes and storage shelves must be powered on and reachable by nodes in the DR site. The metrocluster heal-aggregates and metrocluster heal-roots APIs must have successfully completed before running the metrocluster-switchback API. A job will be spawned to operate on the metrocluster and the job id will be returned. The progress of the job can be tracked using the job APIs. A job will be spawned to operate on the metrocluster and the job id will be returned. The progress of the job can be tracked using the job APIs.

Inputs

Outputs

metrocluster_switchover

[Family: cluster]

The metrocluster-switchover API initiates the switchover of storage and client access from a disaster stricken site to the DR site. Nodes in the disaster stricken site must be powered off and unreachable by nodes in the DR site before initiating the switchover operation. A job will be spawned to operate on the metrocluster and the job id will be returned. The progress of the job can be tracked using the job APIs. A job will be spawned to operate on the metrocluster and the job id will be returned. The progress of the job can be tracked using the job APIs.

Inputs

Outputs

metrocluster_unconfigure

[Family: cluster]

The metrocluster-unconfigure API wipes the configuration from nodes in a DR group which are in the local cluster where the API is issued. This includes all the nodes in the specified DR group in that local cluster. Nodes in the DR group are disallowed from participating in the metrocluster switchover after the configuration has been wiped. This API is used to tear down a metrocluster setup. The tear down of a node is completed when the hardware that activates the node for metrocluster, such as an FC-VI adapter, is removed or deactivated. A job will be spawned to operate on the metrocluster and the job id will be returned. The progress of the job can be tracked using the job APIs.

Inputs

Outputs

metrocluster_vserver_get_iter

[Family: cluster]

Iterate over a list of metrocluster objects.

Inputs

Outputs

metrocluster_vserver_resync

[Family: cluster]

Resynchronize Vserver with its partner Vserver

Inputs

Outputs

metrocluster_check_connection_get_iter

[Family: cluster]

Iterate over a list of metrocluster-check-connection-info objects

Inputs

Outputs

metrocluster_configuration_settings_get_iter

[Family: cluster]

Iterate over a list of metrocluster-configuration-settings-info objects

Inputs

Outputs

metrocluster_connection_connect_async

[Family: cluster]

Configure the connections that mirror the NV logs and access remote storage between partner nodes in MetroCluster sertup A job will be spawned to operate on the metrocluster-connection and the job id will be returned. The progress of the job can be tracked using the job APIs.

Inputs

Outputs

metrocluster_connection_disconnect_async

[Family: cluster]

Tear down the connections that mirror the NV logs and access remote storage between partner nodes in MetroCluster setup A job will be spawned to operate on the metrocluster-connection and the job id will be returned. The progress of the job can be tracked using the job APIs.

Inputs

Outputs

metrocluster_connection_get_iter

[Family: cluster]

Iterate over a list of metrocluster-connection-info objects

Inputs

Outputs

metrocluster_dr_group_create

[Family: cluster]

Create MetroCluster DR group

Inputs

Outputs

metrocluster_dr_group_delete

[Family: cluster]

Delete MetroCluster DR group

Inputs

Outputs

metrocluster_dr_group_get_iter

[Family: cluster]

Iterate over a list of metrocluster-dr-group-info objects

Inputs

Outputs

metrocluster_interface_create

[Family: cluster]

Create a MetroCluster Interface

Inputs

Outputs

metrocluster_interface_delete

[Family: cluster]

Delete a MetroCluster Interface

Inputs

Outputs

metrocluster_interface_get_iter

[Family: cluster]

Iterate over a list of metrocluster-interface-info objects

Inputs

Outputs

name_mapping_create

[Family: vserver]

Create a new name mapping for a Vserver.

Inputs

Outputs

name_mapping_delete

[Family: vserver]

Delete an existing name mapping entry.

Inputs

Outputs

name_mapping_get_iter

[Family: cluster, vserver]

Retrieve the list of name mappings in the cluster.

Inputs

Outputs

name_mapping_insert

[Family: vserver]

Insert a name mapping into the table at a specified position.

Inputs

Outputs

name_mapping_modify

[Family: vserver]

Modify an existing name mapping entry.

Inputs

Outputs

name_mapping_refresh_hostname

[Family: vserver]

Resolve The IP addresses for the configured Hostname.

Inputs

Outputs

name_mapping_swap

[Family: vserver]

Swap the position of one name mapping with another. The position is the place in the sequence of name mappings in which the mappings are applied.

Inputs

Outputs

name_mapping_unix_group_add_user

[Family: vserver]

Add a user to a UNIX group

Inputs

Outputs

name_mapping_unix_group_create

[Family: vserver]

Create a new UNIX group.

Inputs

Outputs

name_mapping_unix_group_delete_user

[Family: vserver]

Delete a user from a UNIX group

Inputs

Outputs

name_mapping_unix_group_destroy

[Family: vserver]

Destroy an existing UNIX group.

Inputs

Outputs

name_mapping_unix_group_get

[Family: vserver]

Get the attributes of a UNIX group.

Inputs

Outputs

name_mapping_unix_group_get_iter

[Family: cluster, vserver]

Iterate over a list of UNIX groups.

Inputs

Outputs

name_mapping_unix_group_modify

[Family: vserver]

Modify the attributes of a UNIX group.

Inputs

Outputs

name_mapping_unix_user_create

[Family: vserver]

Create a new UNIX user.

Inputs

Outputs

name_mapping_unix_user_destroy

[Family: vserver]

Destroy an existing UNIX user.

Inputs

Outputs

name_mapping_unix_user_get

[Family: vserver]

Get the attributes of a UNIX user.

Inputs

Outputs

name_mapping_unix_user_get_iter

[Family: cluster, vserver]

Iterate over a list of UNIX users.

Inputs

Outputs

name_mapping_unix_user_modify

[Family: vserver]

Modify the attributes of a UNIX user.

Inputs

Outputs

name_service_cache_group_membership_settings_get

[Family: vserver]

Get the name services group membership cache configuration of the Vserver

Inputs

Outputs

name_service_cache_group_membership_settings_modify

[Family: vserver]

Modify the name services group membership cache configuration of the specified Vserver. Omitted (optional) fields will not be changed.

Inputs

Outputs

name_service_cache_hosts_settings_get

[Family: vserver]

Get the name services hosts cache configuration of the Vserver

Inputs

Outputs

name_service_cache_hosts_settings_modify

[Family: vserver]

Modify the name services hosts cache configuration of the specified Vserver. Omitted (optional) fields will not be changed.

Inputs

Outputs

name_service_cache_netgroup_settings_get

[Family: vserver]

Get the name services netgroup cache configuration of the Vserver

Inputs

Outputs

name_service_cache_netgroup_settings_modify

[Family: vserver]

Modify the name services netgroup cache configuration of the specified Vserver. Omitted (optional) fields will not be changed.

Inputs

Outputs

name_service_cache_unix_group_settings_get

[Family: vserver]

Get the name services UNIX group cache configuration of the Vserver

Inputs

Outputs

name_service_cache_unix_group_settings_modify

[Family: vserver]

Modify the name services UNIX group cache configuration of the specified Vserver. Omitted (optional) fields will not be changed.

Inputs

Outputs

name_service_cache_unix_user_settings_get

[Family: vserver]

Get the name services UNIX users cache configuration of the Vserver

Inputs

Outputs

name_service_cache_unix_user_settings_modify

[Family: vserver]

Modify the name services UNIX users cache configuration of the specified Vserver. Omitted (optional) fields will not be changed.

Inputs

Outputs

name_service_dns_statistics_get_iter

[Family: cluster, vserver]

Retrieve DNS statistics of the cluster.

Inputs

Outputs

name_service_nis_binding_detail_get

[Family: vserver]

Show bound NIS servers

Inputs

Outputs

name_service_nis_binding_detail_get_iter

[Family: cluster, vserver]

Iterate over a list of bound NIS servers

Inputs

Outputs

name_service_nis_show_bound

[Family: vserver]

Show bound nis servers

Inputs

Outputs

name_service_nis_show_bound_iter

[Family: cluster, vserver]

Iterate over a list of bound nis servers

Inputs

Outputs

name_service_nis_statistics_get_iter

[Family: cluster, vserver]

Retrieve NIS statistics of the cluster.

Inputs

Outputs

name_service_unix_group_fileonly_get

[Family: vserver]

Display Configuration for UNIX-Group file download

Inputs

Outputs

name_service_unix_user_fileonly_get

[Family: vserver]

Display Configuration for UNIX-User file download

Inputs

Outputs

nameservice_dns_statistics_clear

[Family: cluster, vserver]

Clear DNS statistics.

Inputs

Outputs

nameservice_get_hostname_from_ipv4

[Family: cluster]

Get the host information from the IP address.

Inputs

Outputs

nameservice_get_ip_from_hostname

[Family: cluster]

Get the IP address information by using the host name.

Inputs

Outputs

nameservice_get_ipv4_from_hostname

[Family: cluster]

Get the IP address information from host name.

Inputs

Outputs

nameservice_nis_statistics_clear

[Family: cluster, vserver]

Clear NIS statistics.

Inputs

Outputs

nameservice_nsswitch_create

[Family: vserver]

Create an Name Service Switch Configuration.

Inputs

Outputs

nameservice_nsswitch_destroy

[Family: vserver]

Destroy an existing Name Service Switch Configuration.

Inputs

Outputs

nameservice_nsswitch_get

[Family: vserver]

Get Name Service Switch Configuration.

Inputs

Outputs

nameservice_nsswitch_get_iter

[Family: cluster, vserver]

Iterate over a list of Name Service Switch Configurations.

Inputs

Outputs

nameservice_nsswitch_modify

[Family: vserver]

Modify the attributes of Name Service Switch Configuration.

Inputs

Outputs

ndmp_node_session_info_get_iter

[Family: cluster]

Iterate over a list of ndmp objects.

Inputs

Outputs

ndmp_node_session_kill

[Family: cluster]

Kill a NDMP session on a node

Inputs

Outputs

ndmp_node_session_kill_all

[Family: cluster]

Kill all NDMP sessions on a node

Inputs

Outputs

ndmp_password_generate

[Family: vserver]

Generate NDMP password for the given user in a specific Vserver context. The generated NDMP password is based on the actual login password for the user; hence it should be regenerated whenever the actual user password is changed.

Inputs

Outputs

ndmp_vserver_attributes_get_iter

[Family: cluster, vserver]

Get NDMP attributes for vserver.

Inputs

Outputs

ndmp_vserver_attributes_modify

[Family: vserver]

Modify NDMP attributes for vserver.

Inputs

Outputs

ndmp_vserver_service_disable

[Family: vserver]

Disable NDMP service on the vserver. Disabling ndmp service on the vserver will not cause any disruption to NDMP operations that are running. Executing this zapi when the ndmp service is already disabled will not result in any errors.

Inputs

Outputs

ndmp_vserver_service_enable

[Family: vserver]

Enable NDMP service on the vserver. Enabling ndmp service on the vserver will not cause any disruption to NDMP operations that are running. Executing this zapi when the ndmp service is already enabled will not result in any errors.

Inputs

Outputs

ndmp_vserver_session_info_get_iter

[Family: cluster, vserver]

Iterate over a list of ndmp objects.

Inputs

Outputs

ndmp_vserver_session_kill

[Family: vserver]

Kill a NDMP session on a vserver

Inputs

Outputs

ndmp_vserver_session_kill_all

[Family: vserver]

Kill all NDMP sessions on a vserver

Inputs

Outputs

data_lif_capacity

[Family: cluster]

Get the IP data LIF capacity of the cluster.

Inputs

Outputs

data_lif_capacity_details

[Family: cluster]

Get the IP data LIF capacity details for each node.

Inputs

Outputs

net_active_routes_get

[Family: vserver]

Get the attributes of the network route active-entry.

Inputs

Outputs

net_active_routes_get_iter

[Family: cluster, vserver]

Iterate over a list of network route active-entry objects.

Inputs

Outputs

net_arp_active_entry_destroy

[Family: cluster]

Delete dynamically learned ARP entries.

Inputs

Outputs

net_arp_active_entry_get

[Family: cluster]

Get the attributes of the network ARP active entry which is present in network stack of the node.

Inputs

Outputs

net_arp_active_entry_get_iter

[Family: cluster]

Iterate over a list of network ARP active entries.

Inputs

Outputs

net_arp_create

[Family: cluster, vserver]

Create a new network ARP entry.

Inputs

Outputs

net_arp_destroy

[Family: cluster, vserver]

Delete an existing network ARP entry.

Inputs

Outputs

net_arp_get

[Family: cluster, vserver]

Get the attributes of the network ARP entry which is present in Vserver.

Inputs

Outputs

net_arp_get_iter

[Family: cluster, vserver]

Iterate over a list of network ARP entries.

Inputs

Outputs

net_bgp_config_create

[Family: cluster]

Create the BGP configuration for a given node.

Inputs

Outputs

net_bgp_config_destroy

[Family: cluster]

Delete the BGP configuration on a given node.

Inputs

Outputs

net_bgp_config_get

[Family: cluster]

Get the BGP configuration for a node.

Inputs

Outputs

net_bgp_config_get_iter

[Family: cluster]

Iterate over the BGP configuration for each node.

Inputs

Outputs

net_bgp_config_modify

[Family: cluster]

Modify BGP configuration for a given node.

Inputs

Outputs

net_bgp_defaults_get

[Family: cluster]

Get the cluster wide default BGP configuration.

Inputs

Outputs

net_bgp_defaults_modify

[Family: cluster]

Modify the cluster wide default BGP configuration.

Inputs

Outputs

net_bgp_peer_group_create

[Family: cluster]

Create a new BGP peer group.

Inputs

Outputs

net_bgp_peer_group_destroy

[Family: cluster]

Destroy an existing BGP peer group.

Inputs

Outputs

net_bgp_peer_group_get

[Family: cluster]

Get the attributes of the peer group.

Inputs

Outputs

net_bgp_peer_group_get_iter

[Family: cluster]

Iterate over a list of BGP peer groups

Inputs

Outputs

net_bgp_peer_group_modify

[Family: cluster]

Modify the attributes of the BGP peer group.

Inputs

Outputs

net_bgp_peer_group_rename

[Family: cluster]

Rename a BGP peer group.

Inputs

Outputs

net_bgp_vserver_status_get

[Family: cluster]

Get BGP status of a Vserver on a given node.

Inputs

Outputs

net_bgp_vserver_status_get_iter

[Family: cluster]

Iterate over BGP Vservers status.

Inputs

Outputs

net_check_failover

[Family: cluster]

Get the list of LIFs at risk.

Inputs

Outputs

net_cluster_ping

[Family: cluster, vserver]

Ping an IP address to verify whether the interface is alive

Inputs

Outputs

net_cluster_ping6

[Family: cluster, vserver]

Ping an IPv6 address to verify whether the interface is alive

Inputs

Outputs

net_connections_receive_window_size_get

[Family: cluster]

Get the receive buffer size properties of a service

Inputs

Outputs

net_connections_receive_window_size_get_iter

[Family: cluster]

Iterate over connections returning receive buffer size properties

Inputs

Outputs

net_connections_receive_window_size_modify

[Family: cluster]

Modify receive buffer size properties

Inputs

Outputs

net_ddns_get

[Family: vserver]

Get the Dynamic DNS Update configuration of the Vserver

Inputs

Outputs

net_ddns_get_iter

[Family: cluster, vserver]

Iterate through Dynamic DNS Update configurations of the cluster

Inputs

Outputs

net_ddns_modify

[Family: vserver]

Modify the Dynamic DNS Update configuration of the specified Vserver. Omitted (optional) fields will not be changed.

Inputs

Outputs

net_device_discovery_get_iter

[Family: cluster]

Iterate over a list of network device discovery objects found by a discovery protocol such as CDP or LLDP.

Inputs

Outputs

net_dns_check_get_iter

[Family: cluster, vserver]

Display the status of a list of name servers

Inputs

Outputs

net_dns_create

[Family: vserver]

Creates DNS configuration for a Vserver

Inputs

Outputs

net_dns_get

[Family: vserver]

Get the DNS configuration of the Vserver

Inputs

Outputs

net_dns_get_iter

[Family: cluster, vserver]

Iterate through DNS configurations of the cluster

Inputs

Outputs

net_dns_modify

[Family: vserver]

Modify the DNS configuration of the specified Vserver. Omitted (optional) fields will not be changed.

Inputs

Outputs

net_external_route_table_create

[Family: cluster]

Create a new external routing table

Inputs

Outputs

net_external_route_table_delete

[Family: cluster]

Delete an existing external routing table

Inputs

Outputs

net_failover_group_add_targets

[Family: cluster]

Add failover targets to a failover group.

Inputs

Outputs

net_failover_group_create

[Family: cluster]

Create a failover group. Failover groups are used to define a set of possible failover targets for LIFs on one or more nodes.

Inputs

Outputs

net_failover_group_destroy

[Family: cluster]

Delete a failover group

Inputs

Outputs

net_failover_group_get

[Family: vserver]

Get the attributes of a failover goup.

Inputs

Outputs

net_failover_group_get_iter

[Family: cluster, vserver]

Iterate over a list of failover group objects.

Inputs

Outputs

net_failover_group_modify

[Family: cluster]

Modify a failover group.

Inputs

Outputs

net_failover_group_remove_targets

[Family: cluster]

Remove failover targets from a failover group.

Inputs

Outputs

net_failover_group_rename

[Family: cluster]

Rename a failover group.

Inputs

Outputs

net_firewall_config_get

[Family: cluster]

Get the attributes of a firewall configuration.

Inputs

Outputs

net_firewall_config_get_iter

[Family: cluster]

Iterate over a list of firewall configuration objects.

Inputs

Outputs

net_firewall_config_modify

[Family: cluster]

Create a new firewall configuration.

Inputs

Outputs

net_firewall_config_modify_iter

[Family: cluster]

Modify the attributes of a firewall configuration or a group of firewall configuration objects.

Inputs

Outputs

net_firewall_policy_create

[Family: cluster]

Create a new firewall policy

Inputs

Outputs

net_firewall_policy_destroy

[Family: cluster]

Destroy an existing firewall policy

Inputs

Outputs

net_firewall_policy_get

[Family: vserver]

Get the attributes of a firewall policy.

Inputs

Outputs

net_firewall_policy_get_iter

[Family: cluster, vserver]

Iterate over a list of firewall policy objects.

Inputs

Outputs

net_firewall_policy_modify

[Family: cluster]

Modify an existing firewall policy.

Inputs

Outputs

net_hosts_create

[Family: vserver]

Create a new IP to host names mapping

Inputs

Outputs

net_hosts_destroy

[Family: vserver]

Delete an existing hosts object.

Inputs

Outputs

net_hosts_get

[Family: vserver]

Given an IP address, return the corresponding IP to host names mapping of the running Vserver context

Inputs

Outputs

net_hosts_get_iter

[Family: cluster, vserver]

Iterate all IP to host name mappings (over all Vserver) of the cluster

Inputs

Outputs

net_hosts_modify

[Family: vserver]

Given an IP address, modify the corresponding IP to host name mapping. Omitted (optional) fields will not be changed.

Inputs

Outputs

net_interface_create

[Family: cluster]

Create a new logical interface.

Inputs